Description
Asynchronously exports a graph report (only CSV available at this time).
This endpoint will execute the query of a saved report and export to the specified format (only CSV available at this time). The ID of the record containing the saved report is used for the reportID
path element. Reports are stored in records of type DataSource
and ReportView
. The list of applicable records can be retrieved from the /records
endpoint such as GET /records?$filter=type eq DataSource or type eq ReportView
. A filter on the title
property should be used to return a particular report.
Responses include a Location
header, which indicates where to poll for export results. For more details on long-running job polling, see Operations endpoint. When the export completes, its status will be completed
, and the response body includes a resourceURL
. To download the exported file, perform a GET on the resourceURL
with the same authentication credentials and flow as the export request. For more details, see Authentication documentation.
POST
/graph/reports/{reportId}/export
Required OAuth Scopes:
graph:read
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
reportId | path | string | true | The unique identifier of the report |
body | body | GraphReportExport | true | Details about the report export |
Body parameter example
{
"format": "csv"
}
Code Samples
curl -X POST https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/export \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
http POST https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/export \
Content-Type:application/json \
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/export" \
--output-document - \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}'
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/export', headers = headers)
print(r.headers['Location'])
Returns
202 - Accepted
Header | Description |
---|---|
Location | The location to poll for the operation result. |
Retry-After | The number of seconds to wait before polling for a result and between polling attempts. |