Retrieve the CSV of a saved report#

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#

This endpoint will execute the query of a saved report and return the data as a CSV string. 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.

GET /platform/v1/graph/reports/{reportId}/csv

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

Code Samples#

curl -X GET https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/csv \
    -H 'Accept: text/csv' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'
http GET https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/csv \
    X-Version:2022-01-01 \
    Accept:text/csv \
    Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/csv" \
    --output-document -  \ 
    --header 'Accept: text/csv' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'
import requests

headers = {
  'X-Version': '2022-01-01',
  'Accept': 'text/csv',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/platform/v1/graph/reports/{reportId}/csv', headers = headers)

print(r.json())

Returns#

200 - Success#

Returns a CSV string of the requested report.

400 - Bad Request#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses#

No example available
{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}
{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}
{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}
{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}
{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}
{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}
{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}
{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}