Get data campaign

Get a data campaign

GET /api/organizations/{organizationId}/campaigns/{campaignId}

Try it

Get data campaign

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId} \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "campaign": {
    "id": 123,
    "dataCampaignDashboardId": 123,
    "created": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "coordinatorUids": [
      123
    ],
    "queries": [
      {
        "name": "<string>",
        "dataset": "<string>",
        "query": "<string>"
      }
    ],
    "links": [
      {
        "icon": "<string>",
        "name": "<string>",
        "link": "<string>"
      }
    ],
    "datasets": [
      "<string>"
    ],
    "pipelineIds": [
      123
    ],
    "projectIds": [
      123
    ],
    "logo": "<string>"
  },
  "graphs": [
    {
      "title": "<string>",
      "link": "<string>",
      "xData": [
        {
          "color": "<string>",
          "legendText": "<string>",
          "popupText": "<string>",
          "values": [
            {
              "id": 123,
              "value": 123
            }
          ],
          "dataType": "dataItems",
          "dataset": "<string>",
          "query": "<string>"
        }
      ],
      "yTicks": [
        "2023-11-07T05:31:56Z"
      ],
      "nextUpdate": "2023-11-07T05:31:56Z"
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

campaignId · integer · required

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

campaign · object · required

Show child attributes

campaign. id · integer · required

campaign. dataCampaignDashboardId · integer · required

campaign. created · string<date-time> · required

campaign. name · string · required

campaign. description · string · required

campaign. coordinatorUids · integer[] · required

List of user IDs that coordinate this campaign

campaign. queries · object[] · required

Show child attributes

campaign.queries. name · string · required

campaign.queries. dataset · string · required

campaign.queries. query · string · required

campaign. links · object[] · required

Show child attributes

campaign.links. icon · string · required

campaign.links. name · string · required

campaign.links. link · string · required

campaign. datasets · string[] · required

campaign. pipelineIds · integer[] · required

campaign. projectIds · integer[] · required

campaign. logo · string

graphs · object[] · required

Show child attributes

graphs. title · string · required

graphs. link · string · required

graphs. xData · object[] · required

Show child attributes

graphs.xData. color · string · required

graphs.xData. legendText · string · required

graphs.xData. popupText · string · required

graphs.xData. values · object[] · required

Show child attributes

graphs.xData.values. id · integer · required

graphs.xData.values. value · number

graphs.xData. dataType · enum<string> · required

Available options: dataItems, time, percentage

graphs.xData. dataset · string

graphs.xData. query · string

graphs. yTicks · string<date-time>[] · required

graphs. nextUpdate · string<date-time> · required

error · string

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