> **The method is rolling out in update `crm 26.2000.0`.** It is not available on every Bitrix24 account. If the method is not yet available on your account, the API returns `422 METHOD_NOT_YET_AVAILABLE` — this indicates that the update has not reached the account yet, rather than an integration error.

## List analytics traces

`GET /v1/crm-traces`

Lists visit traces linked to one CRM record to help analyze the sources of customer inquiries.

> This operation requires the `crm-tracking-v3` flag and the REST v3 analytics capability enabled in the Bitrix24 account. The key needs the `crm` scope.

A `READONLY` key can read this resource.

## Parameters

| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| `entityType` (query) | string | yes | — | Record type: `LEAD`, `DEAL`, `CONTACT`, `COMPANY`, `QUOTE`. |
| `entityId` (query) | number | yes | — | Positive record ID of the selected type. Use the lists of [leads](/docs/entities/leads/list), [deals](/docs/entities/deals/list), [contacts](/docs/entities/contacts/list), [companies](/docs/entities/companies/list), or [quotes](/docs/entities/quotes/list). |
| `limit` (query) | number | no | 50 | Page size, from 1 to 500. |
| `offset` (query) | number | no | 0 | Number of records to skip before the page. A nonnegative integer. |

Pagination: one request reads one page. Increase `offset` by `limit` for the next page. No total count or next-page indicator is returned. The `filter`, `select` and `sort` parameters are not accepted.

## Examples

### curl — personal key

```bash
curl -X GET "https://vibecode.bitrix24.com/v1/crm-traces?entityType=DEAL&entityId=11&limit=50&offset=0" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl -X GET "https://vibecode.bitrix24.com/v1/crm-traces?entityType=DEAL&entityId=11&limit=50&offset=0" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/crm-traces?entityType=DEAL&entityId=11&limit=50&offset=0', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY"
  }
})
const result = await res.json()
console.log(result)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/crm-traces?entityType=DEAL&entityId=11&limit=50&offset=0', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
})
const result = await res.json()
console.log(result)
```

## Response fields

| Field | Type | Description |
|---|---|---|
| `success` | boolean | `true` |
| `data` | array | Visit traces. |
| `data[].id` | number | Trace ID. |
| `data[].sourceId` | number or null | Analytics source ID. |
| `data[].createdTime` | string | Creation time, ISO 8601. |
| `data[].isMobile` | boolean | Whether the visit used a mobile device. |
| `data[].channels` | array | Channels with `code`, `value` fields. Text can be `null`. |
| `data[].pages` | array | Pages with `url`, `title`, `time` fields. Time is ISO 8601. Text can be `null`. |
| `data[].utm` | object or null | Tags `source`, `medium`, `campaign`, `content`, `term`, each a string or `null`. |
| `meta.limit` | number | Requested page size. |
| `meta.offset` | number | Requested offset. |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "sourceId": 2,
      "createdTime": "2026-10-28T11:59:18+00:00",
      "isMobile": false,
      "channels": [
        {
          "code": "form",
          "value": "5"
        }
      ],
      "pages": [
        {
          "url": "https://example.com/p",
          "title": "VIBE-PROBE page",
          "time": "2026-10-28T10:00:00+00:00"
        }
      ],
      "utm": {
        "source": "vibeprobe",
        "medium": null,
        "campaign": "x",
        "content": null,
        "term": null
      }
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0
  }
}
```

## Error response example

400: required filter missing.

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "entityType and entityId are required"
  }
}
```

## Errors

| HTTP | Code | Description |
|---|---|---|
| 400 | `MISSING_REQUIRED_FIELDS` | Required request fields are missing. |
| 400 | `INVALID_PARAMS` | Invalid request type or shape, or an invalid ID. |
| 403 | `SCOPE_DENIED` | Missing `crm` scope. |
| 401 | `TOKEN_MISSING` | The key has no configured tokens. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | The platform flag is off or RestV3Tracking is not enabled on the Bitrix24 account. `error.release` is `crm 26.2000.0`. |
| 502 | `BITRIX_UNAVAILABLE` | Invalid Bitrix24 response. |
| 400 | `UNKNOWN_FILTER_FIELD` | An unsupported query parameter was supplied. |
| 404 | `ENTITY_NOT_FOUND` | The CRM record is missing or cannot be read. |
| 403 | `BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION` | Insufficient permissions for linked CRM records. |

Other Bitrix24 refusal codes, statuses and messages are preserved. See [Errors](/docs/errors) for common failures.

## Known specifics

Credential fragments in text fields are redacted. Page addresses without sensitive data are preserved unchanged.

## See also

- [Get an analytics trace](/docs/entities/crm-traces/v3-get)
- [Create an analytics trace](/docs/entities/crm-traces/v3-create)
- [Delete an analytics trace](/docs/entities/crm-traces/v3-delete)