analytics.customer_report
Get customer-level analytics for a store over a given period.
Request
- Base URL: https://api.api2cart.com/v1.1
- URL: https://api.api2cart.com/v1.1/analytics.customer_report.json
- Auth: API key in header x-api-key and API key in header x-store-key
Query parameters
Start date for the analytics period (Y-m-d or Y-m-d H:i:s)
End date for the analytics period (Y-m-d or Y-m-d H:i:s). Defaults to the current date.
This parameter sets the entity amount that has to be retrieved. Max allowed count=250
Currency Id
Store Id
Filter analytics customers by customer type
Filter analytics customers by email
Set field to sort by
Set sorting direction
Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
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
Changes
No recorded changes to this operation across all 1 revision of this API.