Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13125317428.7 KB
reports

Retrieves merchant performance metrics matching the search query and optionally segmented by selected dimensions.

post/{merchantId}/reports/search

Path parameters

merchantIdstring required

Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.

Request body

pageSizeinteger

Number of ReportRows to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.

pageTokenstring

Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from next_page_token in the previous response should be used.

querystring

Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. For details on how to construct your query, see the Query Language guide.

Response

Successful response