<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/chargebacks/chargeback-analytics -->

# Chargeback Analytics

Retrieve time-series chargeback analytics data with configurable granularity.

<EndpointHeader verb="GET" path="/merchant/api/v1/chargebacks/analytics" />

## Request

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
    { name: "Content-Type", required: true, desc: "`application/json`" },
    { name: "X-Merchant-Id", required: true, desc: "Merchant identifier" },
    { name: "X-Request-Id", required: true, desc: "Unique request identifier" },
  ]}
/>

### Query Parameters

<ParamTable
  rows={[
    { name: "startDate", type: "string", desc: "Start date filter (ISO 8601)" },
    { name: "endDate", type: "string", desc: "End date filter (ISO 8601)" },
    { name: "granularity", type: "string", desc: "Time bucket size: `day`, `week`, `month` (default: `day`)" },
    { name: "currency", type: "string", desc: "Filter by ISO 4217 currency code" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "granularity": "day",
    "currency": "USD",
    "timeSeries": [
      {
        "date": "2024-01-13",
        "totalChargebacks": 3,
        "totalAmount": 450.00,
        "wonCount": 1,
        "lostCount": 1,
        "pendingCount": 1
      },
      {
        "date": "2024-01-14",
        "totalChargebacks": 5,
        "totalAmount": 820.50,
        "wonCount": 3,
        "lostCount": 0,
        "pendingCount": 2
      },
      {
        "date": "2024-01-15",
        "totalChargebacks": 2,
        "totalAmount": 175.25,
        "wonCount": 0,
        "lostCount": 1,
        "pendingCount": 1
      }
    ]
  },
  "message": "Chargeback analytics retrieved successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "processing_time_ms": 68,
    "api_version": "v1",
    "endpoint": "GET /chargebacks/analytics",
    "user_type": "merchant"
  }
}
```

### Error Responses

<ErrorTable
  rows={[
    { code: "VALIDATION_ERROR", status: "400", message: "Invalid query parameters" },
    { code: "UNAUTHORIZED", status: "401", message: "Invalid API key" },
  ]}
/>

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
curl -X GET "https://api.zenpayz.com/merchant/api/v1/chargebacks/analytics?startDate=2024-01-01T00:00:00.000Z&endDate=2024-01-31T23:59:59.000Z&granularity=day&currency=USD" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json" \
  -H "X-Merchant-Id: merch_xxxxx" \
  -H "X-Request-Id: req_xxxxx"
```

  </TabItem>
  <TabItem value="javascript" label="JavaScript">

```javascript
const params = new URLSearchParams({
  startDate: '2024-01-01T00:00:00.000Z',
  endDate: '2024-01-31T23:59:59.000Z',
  granularity: 'day',
  currency: 'USD',
});

const response = await fetch(`https://api.zenpayz.com/merchant/api/v1/chargebacks/analytics?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'X-Timestamp': timestamp,
    'X-Signature': signature,
    'X-Secret-Salt': secretSalt,
    'Content-Type': 'application/json',
    'X-Merchant-Id': merchantId,
    'X-Request-Id': requestId,
  },
});

const result = await response.json();
console.log(result.data.timeSeries); // [{ date: "2024-01-13", totalChargebacks: 3, ... }]
console.log(result.data.granularity); // "day"
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

```javascript
const analytics = await zenpays.chargebacks.analytics({
  startDate: '2024-01-01T00:00:00.000Z',
  endDate: '2024-01-31T23:59:59.000Z',
  granularity: 'day',
  currency: 'USD',
});

console.log(analytics.timeSeries); // [{ date: "2024-01-13", totalChargebacks: 3, ... }]
console.log(analytics.granularity); // "day"
```

  </TabItem>
</Tabs>

</CodeRail>

## Related Endpoints

- [Chargeback Stats](/docs/rest-api/endpoints/chargebacks/chargeback-stats)
- [List Chargebacks](/docs/rest-api/endpoints/chargebacks/list-chargebacks)
- [Get Chargeback](/docs/rest-api/endpoints/chargebacks/get-chargeback)
