---
title: "analytics.customer_report"
method: GET
path: "/analytics.customer_report.json"
tags: ["analytics"]
---

# analytics.customer_report

`GET /analytics.customer_report.json`

## 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`

Get customer-level analytics for a store over a given period.

## Query parameters

- `date_from` string
- `date_to` string
- `count` integer
- `currency_id` string
- `store_id` string
- `customer_type` string
- `email` string
- `sort_by` string
- `sort_direction` string
- `page_cursor` string
- `response_fields` string

## Response `200`

successful operation

- ResponseAnalyticsCustomerReportResult
  - `period` AnalyticsPeriod
    - `date_from` string
    - `date_to` string
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `items` AnalyticsCustomer[]
    - `customer_id` string
    - `name` string, nullable
    - `email` string, nullable
    - `customer_type` string, nullable
    - `metrics` AnalyticsCustomerMetric
      - `orders_count` integer, nullable
      - `total_spend` number, nullable
      - `avg_order_value` number, nullable
      - `currency_id` string, nullable
      - `additional_fields` object, nullable
      - `custom_fields` object, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `additional_fields` object, nullable
  - `custom_fields` object, nullable

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)