Get data campaigns

Get data campaigns

Get a list of all data campaigns for a dashboard

get

/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/campaigns

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

campaignDashboardIdintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaign-dashboard/{campaignDashboardId}/campaigns' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "campaigns": [
    {
      "campaign": {
        "id": 1,
        "dataCampaignDashboardId": 1,
        "created": "2025-02-21T18:13:54.859Z",
        "name": "text",
        "description": "text",
        "logo": "text",
        "coordinatorUids": [
          1
        ],
        "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",
          "nextUpdate": "2025-02-21T18:13:54.859Z",
          "yTicks": [
            "2025-02-21T18:13:54.859Z"
          ],
          "xData": [
            {
              "color": "text",
              "legendText": "text",
              "popupText": "text",
              "dataset": "text",
              "query": "text",
              "dataType": "dataItems",
              "values": [
                {
                  "id": 1,
                  "value": 1
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

OK