Skip to main content
GET
/
v1
/
webhook-custom-kpi
/
dataset
Get Public Dataset
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

fetch('https://api.dcycle.io/v1/webhook-custom-kpi/dataset', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_name": "<string>",
  "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataset_name": "<string>",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "deadline": "2023-12-25",
  "kpis": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "sort_order": 123,
      "description": "<string>",
      "unit": "<string>",
      "current_value": 123
    }
  ],
  "organization_name": "<string>"
}

Headers

x-organization-id
string
x-api-key
string
required

Query Parameters

campaign_assignment_id
string<uuid>
required
token
string
required
Required string length: 64
deadline
string
required
Maximum string length: 10

Response

Successful Response

Dataset data shown on the public form.

campaign_id
string<uuid>
required
campaign_name
string
required
dataset_id
string<uuid>
required
dataset_name
string
required
period_start
string<date>
required
period_end
string<date>
required
deadline
string<date>
required
kpis
PublicKpiSch · object[]
required
organization_name
string