Get data campaign

Get data campaign

Get a data campaign

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}
Path parameters
organizationId*integer

Organization ID

campaignId*integer
Response

OK

Body
success*boolean

Whether the operation succeeded

errorstring

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

campaign*DataCampaign (object)
graphs*array of DataCampaignGraph (object)
Request
const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "success": false,
  "error": "text",
  "campaign": {
    "id": 0,
    "dataCampaignDashboardId": 0,
    "created": "2025-01-11T20:13:15.773Z",
    "name": "text",
    "description": "text",
    "coordinatorUids": [
      0
    ],
    "logo": "text",
    "queries": [
      {
        "name": "text",
        "dataset": "text",
        "query": "text"
      }
    ],
    "links": [
      {
        "icon": "text",
        "name": "text",
        "link": "text"
      }
    ],
    "datasets": [
      "text"
    ],
    "pipelineIds": [
      0
    ],
    "projectIds": [
      0
    ]
  },
  "graphs": [
    {
      "title": "text",
      "link": "text",
      "xData": [
        {
          "color": "text",
          "legendText": "text",
          "popupText": "text",
          "values": [
            {
              "id": 0,
              "value": 0
            }
          ],
          "dataset": "text",
          "query": "text",
          "dataType": "dataItems"
        }
      ],
      "yTicks": [
        "2025-01-11T20:13:15.773Z"
      ],
      "nextUpdate": "2025-01-11T20:13:15.773Z"
    }
  ]
}

Last updated