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

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

campaign*DataCampaign (object)

graphs*array of DataCampaignGraph (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "error": "text",
  "campaign": {
    "created": "2024-11-21T08:30:47.568Z",
    "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-11-21T08:30:47.568Z"
      ],
      "nextUpdate": "2024-11-21T08:30:47.568Z"
    }
  ]
}