---
title: "Get data campaign"
method: GET
path: "/api/organizations/{organizationId}/campaigns/{campaignId}"
tags: ["OrganizationDataCampaigns"]
---

# Get data campaign

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

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/campaigns/:campaignId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a data campaign

## Path parameters

- `organizationId` integer, required
- `campaignId` integer, required

## Response `200`

OK

- GetOrganizationDataCampaignResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `campaign` DataCampaign, required
    - `id` integer, required
    - `dataCampaignDashboardId` integer, required
    - `created` string, date-time, required
    - `name` string, required
    - `description` string, required
    - `coordinatorUids` integer[], required: List of user IDs that coordinate this campaign
    - `logo` string
    - `queries` DataCampaignQuery[], required
      - `name` string, required
      - `dataset` string, required
      - `query` string, required
    - `links` DataCampaignLink[], required
      - `icon` string, required
      - `name` string, required
      - `link` string, required
    - `datasets` string[], required
    - `pipelineIds` integer[], required
    - `projectIds` integer[], required
  - `graphs` DataCampaignGraph[], required
    - `title` string, required
    - `link` string, required
    - `xData` object[], required
      - `color` string, required
      - `legendText` string, required
      - `popupText` string, required
      - `values` object[], required
        - `id` integer, required
        - `value` number
      - `dataset` string
      - `query` string
      - `dataType` 'dataItems' | 'time' | 'percentage', required
    - `yTicks` string[], required
    - `nextUpdate` string, date-time, required

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)