Get Campaign
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"id": "<string>",
"dataset_id": "<string>",
"name": "<string>",
"period_start": "<string>",
"period_end": "<string>",
"deadline": "<string>",
"locked_at": {},
"created_by": {},
"updated_by": {},
"created_at": {},
"updated_at": {},
"campaign_assignments": {
"id": "<string>",
"campaign_id": "<string>",
"assignment_id": "<string>",
"last_invited_at": {},
"completed_at": {},
"status": "<string>",
"assignment": {
"id": "<string>",
"dataset_id": "<string>",
"organization_id": "<string>",
"facility_id": {},
"data_owner_user_id": {},
"data_owner_email": "<string>",
"created_at": {},
"updated_at": {}
},
"created_at": {},
"updated_at": {}
}
}Get Campaign
Retrieve a campaign with its recipients and their statuses
GET
/
v1
/
custom-kpi-datasets
/
{dataset_id}
/
campaigns
/
{campaign_id}
Get Campaign
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"id": "<string>",
"dataset_id": "<string>",
"name": "<string>",
"period_start": "<string>",
"period_end": "<string>",
"deadline": "<string>",
"locked_at": {},
"created_by": {},
"updated_by": {},
"created_at": {},
"updated_at": {},
"campaign_assignments": {
"id": "<string>",
"campaign_id": "<string>",
"assignment_id": "<string>",
"last_invited_at": {},
"completed_at": {},
"status": "<string>",
"assignment": {
"id": "<string>",
"dataset_id": "<string>",
"organization_id": "<string>",
"facility_id": {},
"data_owner_user_id": {},
"data_owner_email": "<string>",
"created_at": {},
"updated_at": {}
},
"created_at": {},
"updated_at": {}
}
}← Custom KPI
Retrieve a campaign including all campaign-assignments (recipients) with their derived statuses:
awaiting, completed, or locked.
Request
Headers
Path Parameters
Response
Returns the campaign with nestedcampaign_assignments array (HTTP 200).
Recipients assigned to this campaign with their completion status.
Show Campaign Assignment Object
Show Campaign Assignment Object
Derived status:
awaiting, completed, or locked (the campaign was locked; a past deadline alone does not lock it).Embedded dataset assignment with recipient details.
Show Assignment Object
Show Assignment Object
Example
curl -X GET "https://api.dcycle.io/v1/custom-kpi-datasets/${DATASET_ID}/campaigns/${CAMPAIGN_ID}" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
import requests
import os
headers = {
"x-api-key": os.getenv("DCYCLE_API_KEY"),
"x-organization-id": os.getenv("DCYCLE_ORG_ID"),
}
dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
campaign_id = "b2c3d4e5-f6a7-8901-bcde-f12345678901"
response = requests.get(
f"https://api.dcycle.io/v1/custom-kpi-datasets/{dataset_id}/campaigns/{campaign_id}",
headers=headers,
)
campaign = response.json()
for ca in campaign["campaign_assignments"]:
print(f" {ca['assignment']['data_owner_email']}: {ca['status']}")
const axios = require('axios');
const headers = {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID,
};
const datasetId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const campaignId = 'b2c3d4e5-f6a7-8901-bcde-f12345678901';
axios.get(`https://api.dcycle.io/v1/custom-kpi-datasets/${datasetId}/campaigns/${campaignId}`, { headers })
.then(response => {
response.data.campaign_assignments.forEach(ca =>
console.log(`${ca.assignment.data_owner_email}: ${ca.status}`)
);
});
Successful Response
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Q1 2025 Water Survey",
"period_start": "2025-01-01",
"period_end": "2025-03-31",
"deadline": "2025-04-15",
"locked_at": null,
"created_by": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"updated_by": null,
"created_at": "2025-06-15T10:00:00Z",
"updated_at": null,
"campaign_assignments": [
{
"id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
"campaign_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"assignment_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"last_invited_at": "2025-06-16T09:00:00Z",
"completed_at": null,
"status": "awaiting",
"assignment": {
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"facility_id": null,
"data_owner_user_id": null,
"data_owner_email": "supplier@example.com",
"created_at": "2025-06-10T08:00:00Z",
"updated_at": null
},
"created_at": "2025-06-15T10:00:00Z",
"updated_at": null
},
{
"id": "a2b3c4d5-e6f7-8901-abcd-ef2345678901",
"campaign_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"assignment_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
"last_invited_at": "2025-06-16T09:00:00Z",
"completed_at": "2025-06-20T14:30:00Z",
"status": "completed",
"assignment": {
"id": "e5f6a7b8-c9d0-1234-efab-345678901234",
"dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"facility_id": "660e8400-e29b-41d4-a716-446655440000",
"data_owner_user_id": "b9f1e2d3-0000-0000-0000-000000000001",
"data_owner_email": "ana.garcia@company.com",
"created_at": "2025-06-10T08:00:00Z",
"updated_at": null
},
"created_at": "2025-06-15T10:00:00Z",
"updated_at": null
}
]
}
Common Errors
401 Unauthorized
Cause: Missing or invalid API key{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
403 Forbidden
Cause: The authenticated user is not a member of the organization{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
404 Not Found
Cause: Campaign not found{
"detail": "Campaign not found"
}
Related Endpoints
Update Campaign
Change campaign name or dates
Send Invites
Notify recipients
Was this page helpful?