Skip to main content
POST
Export Report Query
Queues an export of any report query and emails the caller download links: an Excel file with Summary and Activities sheets, and/or the activities as CSV. The file holds every matching activity up to 50,000, and the email says when it stops short. Requires a CRM read scope; the files only ever go to the caller’s own address.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
ReportQuery · object
required
formats
enum<string>[]
required

xlsx: Summary and Activities sheets. csv: the activities.

Minimum array length: 1
Available options:
xlsx,
csv
title
string
required

Report name.

Maximum string length: 200
timezone
string
default:UTC

Requester's IANA timezone.

period_label
string
default:""
Maximum string length: 200
scope_label
string
default:""

The filters, in words.

Maximum string length: 1000
measure_label
string
default:""
Maximum string length: 200

Response

Successful Response

The response is of type Response Export Report Query Reports Export Post · object.