Skip to main content
POST
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
responses
Create Response
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    campaign_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    values: [
      {
        kpi_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        value_numeric: 123,
        value_text: '<string>',
        value_date: '2023-12-25'
      }
    ],
    facility_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    attachment_file_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/responses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "campaign_assignment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "submitted_at": "2023-11-07T05:31:56Z",
  "values": [
    {
      "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",
      "created_at": "2023-11-07T05:31:56Z",
      "value_numeric": 123,
      "value_text": "<string>",
      "value_date": "2023-12-25",
      "submitter_email": "<string>",
      "submitter_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "attachments": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "file_name": "<string>",
      "file_url": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Headers

x-organization-id
string
x-api-key
string
x-user-id
string

Path Parameters

dataset_id
string<uuid>
required

Body

application/json

Request schema for submitting a Custom KPI response.

organization_id
string<uuid>
required
campaign_id
string<uuid>
required
values
ResponseValueEntrySch · object[]
required
Required array length: 1 - 100 elements
facility_id
string<uuid>
attachment_file_ids
string<uuid>[]
Maximum array length: 20

Response

Successful Response

Returned after creating an in-app response.

campaign_assignment_id
string<uuid>
required
submitted_at
string<date-time>
required
values
ValueSch · object[]
required
attachments
ResponseAttachmentSch · object[]
required