Initiate a graph report export

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2029-01-31.

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 /platform/v1/graph/reports/{reportId}/export

Required OAuth Scopes

graph:read

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
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

curl -X POST https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/export \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http POST https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/export \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/export" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': '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'])