Skip to main content
GET
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
campaigns
List Campaigns
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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "period_start": "2023-12-25",
    "period_end": "2023-12-25",
    "deadline": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "locked_at": "2023-11-07T05:31:56Z",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_at": "2023-11-07T05:31:56Z",
    "recipient_count": 0,
    "response_count": 0,
    "completed_count": 0,
    "recipients_preview": [
      {
        "data_owner_email": "<string>",
        "data_owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
]

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

Response

Successful Response

id
string<uuid>
required

The campaign id.

dataset_id
string<uuid>
required

The parent dataset id.

name
string
required
period_start
string<date>
required
period_end
string<date>
required
deadline
string<date>
required
created_at
string<date-time>
required
locked_at
string<date-time>
created_by
string<uuid>
updated_by
string<uuid>
updated_at
string<date-time>
recipient_count
integer
default:0
response_count
integer
default:0
completed_count
integer
default:0
recipients_preview
CampaignRecipientPreviewSch · object[]