Custom reports
This API lets you find URLs for downloading custom reports in a CSV format.
Listing
To list all your custom reports via API, use GET /custom-reports.
Example
json
[
{
"customReportId": "cRi",
"name": "Example Report",
"href": "https://api.getresponse.com/v3/custom-reports/cRi",
"frequency": "daily",
"createdAt": "2020-11-20T08:00:00+0000",
"generatedAt": "2020-11-20T08:00:00+0000"
}
]Details
To obtain details about specific custom report, you will need customReportId. Use the request: GET /custom-reports/{customReportId}.
Example
json
{
"customReportId": "cRi",
"name": "Example Report",
"href": "https://api.getresponse.com/v3/custom-reports/cRi",
"type": "daily",
"scheduling": {
"frequency": "one_time",
"oneTime": {
"startDate": "2020-11-20T08:00:00+0000",
"endDate": "2020-11-21T08:00:00+0000"
},
"recurring": null
},
"createdAt": "2020-11-20T08:00:00+0000",
"generatedAt": "2020-11-20T08:00:00+0000",
"files": [
{
"customReportFileId": "cRiF",
"downloadUrl": "https://url/to/file",
"status": "ready",
"expiresAt": "2020-11-20T08:00:00+0000"
}
]
}The relations between frequency and other fields within the scheduling node are as follows:
| frequency | oneTime | recurring | Description |
|---|---|---|---|
one_time | startDate, endDate | null | For one-time reports, the start and end dates are set and recurring is not available |
daily | null | hour | For daily reports, we set recurring by hour as an integer from 0 to 23 |
weekly | null | dayOfWeek , hour | For weekly reports, we set recurring by dayOfWeek as string (Monday—Sunday) and hour as an integer from 0 to 23 |
monthly | null | dayOfMonth , hour | For monthly reports, we set recurring by dayOfMonth as an integer from 1 to 31 and hour as an integer from 0 to 23 |
How can find out if the report is ready?
Webhooks are the most convenient way to receive instant notifications. Create the generated webhook to get notified as soon as the report is ready. Alternatively, you can use API to manually check the status of your report using the getList/getDetails methods listed above. However, we recommend webhooks for their efficiency and ability to provide real time updates.
How do I download a report?
To download your report, you first need to get its ID customReportId using a webhook or by searching the list of custom reports. Next, use the customReportId to call custom report details. The download links are under the files node.