GET
/
api
/
organizations
/
{organizationId}
/
campaigns
/
{campaignId}
Get data campaign
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "campaign": {
    "id": 123,
    "dataCampaignDashboardId": 123,
    "created": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "coordinatorUids": [
      123
    ],
    "logo": "<string>",
    "queries": [
      {
        "name": "<string>",
        "dataset": "<string>",
        "query": "<string>"
      }
    ],
    "links": [
      {
        "icon": "<string>",
        "name": "<string>",
        "link": "<string>"
      }
    ],
    "datasets": [
      "<string>"
    ],
    "pipelineIds": [
      123
    ],
    "projectIds": [
      123
    ]
  },
  "graphs": [
    {
      "title": "<string>",
      "link": "<string>",
      "xData": [
        {
          "color": "<string>",
          "legendText": "<string>",
          "popupText": "<string>",
          "values": [
            {
              "id": 123,
              "value": 123
            }
          ],
          "dataset": "<string>",
          "query": "<string>",
          "dataType": "dataItems"
        }
      ],
      "yTicks": [
        "2023-11-07T05:31:56Z"
      ],
      "nextUpdate": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

campaignId
integer
required

Response

200 - application/json

OK

The response is of type object.