/Reports/:record/:type GET
Overview
An API to run a saved report and export the result.
Summary
This endpoint will export the result of a saved report in one of the following formats: pdf, base64, csv, and json ('rows and columns' reports only).
Request Arguments
Name | Type | Description | Required |
---|---|---|---|
record | String | ID of a saved report | True |
export_type | String | Format of exported data. It can be one of the following formats: pdf , base64 , csv , and json . CSV and JSON export types are only currently available for 'Rows and Columns' reports. |
True |
Request Example
GET /rest/v11/Reports/:id/json
Response Example
[
{
"Contact ID":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"First Name":"Dale",
"Last Name":"Arvizu",
"Email Address":"vegan.sugar.support@example.co.uk",
"Account Name":"DD Furniture Inc"
},
{
"Contact ID":"71c773ce-980e-11eb-8f85-f45c898a3ce7",
"First Name":"Isis",
"Last Name":"Arvizu",
"Email Address":"im38@example.info",
"Account Name":"J.K.M. Corp (HA)"
},
]
Change Log
Version | Change |
---|---|
v11.13 | Added csv and json formats. |