curl --request GET \
--url https://{subdomain}.conveyour.com/api/reports/{report_id} \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/reports/{report_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/reports/{report_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/reports/{report_id}"
headers = {"x-conveyour-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/reports/{report_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "Success",
"data": {
"id": "campaignsCampaignPerformance",
"title": "Campaign Performance",
"visual": "table",
"exportable": true,
"controls": [
{
"key": "campaign_id",
"title": "Campaign",
"type": "m_id",
"required": true
},
{
"key": "start_date",
"title": "Start Date",
"type": "date",
"default": "2026-01-01"
}
],
"fields": [
{
"key": "contact_name",
"title": "Contact Name",
"type": "string"
},
{
"key": "progress",
"title": "Progress",
"type": "perc"
},
{
"key": "completed_at",
"title": "Completed At",
"type": "date"
}
],
"data": [
{
"contact_name": "Jane Doe",
"progress": 0.75,
"completed_at": "2026-06-15T10:22:00Z"
}
]
}
}{
"status": "failed",
"message": "Token is either expired or does not have the correct permissions",
"data": []
}Get a report
Returns a specific report. By default returns only the report schema (controls, fields, visual type) without executing the query. Pass data=1 to also run the query and include rows.
Get report schema and optionally data (data=1)
Report control parameters. Beyond the flags above, a report accepts whatever controls it declares — commonly campaign_id, start_date, end_date, search and group. They are report-specific and are not listed here because they differ per report; read the controls field returned by this endpoint to discover them, then send them as ordinary query parameters.
A missing record does not return 404. This handler reports the failure without a status code, and the error envelope defaults to HTTP 200 — you get 200 with status: "failed". Branch on status, not on the HTTP code.
curl --request GET \
--url https://{subdomain}.conveyour.com/api/reports/{report_id} \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/reports/{report_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/reports/{report_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/reports/{report_id}"
headers = {"x-conveyour-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/reports/{report_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "Success",
"data": {
"id": "campaignsCampaignPerformance",
"title": "Campaign Performance",
"visual": "table",
"exportable": true,
"controls": [
{
"key": "campaign_id",
"title": "Campaign",
"type": "m_id",
"required": true
},
{
"key": "start_date",
"title": "Start Date",
"type": "date",
"default": "2026-01-01"
}
],
"fields": [
{
"key": "contact_name",
"title": "Contact Name",
"type": "string"
},
{
"key": "progress",
"title": "Progress",
"type": "perc"
},
{
"key": "completed_at",
"title": "Completed At",
"type": "date"
}
],
"data": [
{
"contact_name": "Jane Doe",
"progress": 0.75,
"completed_at": "2026-06-15T10:22:00Z"
}
]
}
}{
"status": "failed",
"message": "Token is either expired or does not have the correct permissions",
"data": []
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Path Parameters
The report_id identifier.
Query Parameters
Pass data=1 to execute the report query and return rows. Without this, only the report schema (controls, fields, visual) is returned.
Pass params=1 to include the resolved query parameters in the response. Useful for debugging filter values.
Pass format=csv to stream the report data as a CSV download instead of JSON.
Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.
Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.
Response
Success.