Get data campaigns

Get data campaigns

Get a list of all data campaigns for a dashboard

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/campaigns

Path parameters

organizationId*integer

Organization ID

campaignDashboardId*integer

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

campaigns*array of object

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/campaigns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "campaigns": [
    {
      "campaign": {
        "created": "2024-07-04T18:13:20.241Z",
        "name": "text",
        "description": "text",
        "coordinatorUids": [],
        "logo": "text",
        "queries": [
          {
            "name": "text",
            "dataset": "text",
            "query": "text"
          }
        ],
        "links": [
          {
            "icon": "text",
            "name": "text",
            "link": "text"
          }
        ],
        "datasets": [
          "text"
        ],
        "pipelineIds": [],
        "projectIds": []
      },
      "graphs": [
        {
          "title": "text",
          "link": "text",
          "xData": [
            {
              "color": "text",
              "legendText": "text",
              "popupText": "text",
              "values": [
                {
                  "value": 0
                }
              ],
              "dataset": "text",
              "query": "text",
              "dataType": "dataItems"
            }
          ],
          "yTicks": [
            "2024-07-04T18:13:20.241Z"
          ],
          "nextUpdate": "2024-07-04T18:13:20.241Z"
        }
      ]
    }
  ]
}