Get data campaigns

Get a list of all data campaigns for a dashboard

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

Try it

Get data campaigns

cURL

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

200

{
  "success": true,
  "campaigns": [
    {
      "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

campaignDashboardId · integer · required

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

campaigns · object[] · required

Show child attributes

campaigns. campaign · object · required

Show child attributes

campaigns.campaign. id · integer · required

campaigns.campaign. dataCampaignDashboardId · integer · required

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

campaigns.campaign. name · string · required

campaigns.campaign. description · string · required

campaigns.campaign. coordinatorUids · integer[] · required

List of user IDs that coordinate this campaign

campaigns.campaign. queries · object[] · required

Show child attributes

campaigns.campaign.queries. name · string · required

campaigns.campaign.queries. dataset · string · required

campaigns.campaign.queries. query · string · required

campaigns.campaign. links · object[] · required

Show child attributes

campaigns.campaign.links. icon · string · required

campaigns.campaign.links. name · string · required

campaigns.campaign.links. link · string · required

campaigns.campaign. datasets · string[] · required

campaigns.campaign. pipelineIds · integer[] · required

campaigns.campaign. projectIds · integer[] · required

campaigns.campaign. logo · string

campaigns. graphs · object[] · required

Show child attributes

campaigns.graphs. title · string · required

campaigns.graphs. link · string · required

campaigns.graphs. xData · object[] · required

Show child attributes

campaigns.graphs.xData. color · string · required

campaigns.graphs.xData. legendText · string · required

campaigns.graphs.xData. popupText · string · required

campaigns.graphs.xData. values · object[] · required

Show child attributes

campaigns.graphs.xData.values. id · integer · required

campaigns.graphs.xData.values. value · number

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

Available options: dataItems, time, percentage

campaigns.graphs.xData. dataset · string

campaigns.graphs.xData. query · string

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

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

error · string

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