analytics

analytics.report

Get analytics report with totals and optional interval breakdown for a store over a given period.

get/analytics.report.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/analytics.report.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

date_fromstring required

Start date for the analytics period (Y-m-d or Y-m-d H:i:s)

date_tostring

End date for the analytics period (Y-m-d or Y-m-d H:i:s). Defaults to the current date.

intervalstring

Interval for analytics report breakdown

order_statusstring

Retrieves orders specified by order status

financial_statusstring

Retrieves orders specified by financial status

currency_idstring

Currency Id

store_idstring

Store Id

sort_bystring

Set field to sort by

sort_directionstring

Set sorting direction

response_fieldsstring

Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.

Response

successful operation

additional_fieldsobject nullable
custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.