Get data campaigns

Get data campaigns

get

Get a list of all data campaigns for a dashboard

Authorizations
Path parameters
organizationIdintegerRequired

Organization ID

campaignDashboardIdintegerRequired
Responses
200
OK
application/json
Responseall of
get
GET /v1/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/campaigns HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*
200

OK

{
  "success": true,
  "error": "text",
  "campaigns": [
    {
      "campaign": {
        "id": 1,
        "dataCampaignDashboardId": 1,
        "created": "2025-06-30T23:27:41.473Z",
        "name": "text",
        "description": "text",
        "coordinatorUids": [
          1
        ],
        "logo": "text",
        "queries": [
          {
            "name": "text",
            "dataset": "text",
            "query": "text"
          }
        ],
        "links": [
          {
            "icon": "text",
            "name": "text",
            "link": "text"
          }
        ],
        "datasets": [
          "text"
        ],
        "pipelineIds": [
          1
        ],
        "projectIds": [
          1
        ]
      },
      "graphs": [
        {
          "title": "text",
          "link": "text",
          "xData": [
            {
              "color": "text",
              "legendText": "text",
              "popupText": "text",
              "values": [
                {
                  "id": 1,
                  "value": 1
                }
              ],
              "dataset": "text",
              "query": "text",
              "dataType": "dataItems"
            }
          ],
          "yTicks": [
            "2025-06-30T23:27:41.473Z"
          ],
          "nextUpdate": "2025-06-30T23:27:41.473Z"
        }
      ]
    }
  ]
}

Last updated

Was this helpful?