Skip to main content
GET
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
campaigns
/
{campaign_id}
/
values
List Campaign Values
const options = {
  method: 'GET',
  headers: {'x-organization-id': '<x-organization-id>', 'x-api-key': '<api-key>'}
};

fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}/values', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaign_assignment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assignment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kpi_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "submitted_at": "2023-11-07T05:31:56Z",
      "kpi_name": "<string>",
      "data_owner_email": "<string>",
      "organization_name": "<string>",
      "value_numeric": 123,
      "submitter_email": "<string>",
      "submitter_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kpi_unit": "<string>",
      "facility_name": "<string>"
    }
  ],
  "total": 123
}

Authorizations

x-api-key
string
header
required

Headers

x-organization-id
string<uuid>
required
x-api-key
string

Path Parameters

dataset_id
string<uuid>
required
campaign_id
string<uuid>
required

Query Parameters

page
integer
default:1
Required range: x >= 1
size
integer
default:20
Required range: 1 <= x <= 100
sort
string
default:-submitted_at

Response

Successful Response

Paginated response for campaign values.

items
CampaignValueRowSch · object[]
required
total
integer
required