The methods are rolling out in update crm 26.2100.0. They are not available on every Bitrix24 account. Until a method is available, the API returns 422 METHOD_NOT_YET_AVAILABLE.

Analytics sources and channels

Sources attribute visits to campaigns and referrals. You can read built-in sources, configure them by code and create custom sources. Channels show which acquisition methods are configured on the account.

Bitrix24 API: crm.tracking.source.*, crm.tracking.channel.list Scope: crm

The crm-tracking-v3 flag and the REST v3 analytics capability in the Bitrix24 account must be enabled. READONLY keys may read; writes require READWRITE.

Operations

• POST /v1/crm-tracking/sources — create a source

• GET /v1/crm-tracking/sources — list sources

• GET /v1/crm-tracking/sources/:id — get a source

• GET /v1/crm-tracking/sources/by-code/:code — get a built-in source

• PATCH /v1/crm-tracking/sources/:id — update a source

• PATCH /v1/crm-tracking/sources/by-code/:code — update a built-in source

• POST /v1/crm-tracking/sources/:id/archive — archive

• POST /v1/crm-tracking/sources/by-code/:code/archive — archive by code

• POST /v1/crm-tracking/sources/:id/unarchive — restore

• POST /v1/crm-tracking/sources/by-code/:code/unarchive — restore by code

• GET /v1/crm-tracking/channels — list channels

• GET /v1/crm-tracking/sources/:id/expenses — list manual expenses

• POST /v1/crm-tracking/sources/:id/expenses — add manual expenses

• DELETE /v1/crm-tracking/expenses/:id — delete manual expenses

• GET /v1/crm-tracking/analytics/sources — source analytics

• GET /v1/crm-tracking/sources/:id/ad-account/authorization — Get an authorization link

• GET /v1/crm-tracking/sources/:id/ad-accounts — List advertising accounts

• POST /v1/crm-tracking/sources/:id/ad-account — Connect an advertising account

• DELETE /v1/crm-tracking/sources/:id/ad-account — Disconnect an advertising account

• GET /v1/crm-tracking/sources/:id/ad-tree — Read the advertising tree

• POST /v1/crm-tracking/sources/:id/ad-expenses — Run an expense report step

• GET /v1/crm-tracking/sources/:id/ad-expenses — Read report progress

Key fields

Field	Description
Fieldid	DescriptionRecord identifier from the source list. null for an unconfigured built-in source.
Fieldcode	DescriptionBuilt-in source code from the source list, such as google. null for a custom source.
Fieldkind	DescriptionbuiltIn for a built-in source, own for a custom one.
FieldisActive	DescriptionWhether the source is active. Read archived records with archived=true.
FieldrefDomains, utmSources	DescriptionReferring domains and UTM source values. Writing a list replaces it completely.

Before you start

1. Address a source by exactly one value: numeric id or string code in the path. A second address in the request is refused.
2. The first update of a built-in source by code creates its record. A missing identifier does not mean that the built-in source itself is absent.
3. The default list includes active sources and unconfigured built-in sources. archived=true selects archived records.
4. Creation returns data.id; an update returns the source read back after the write. Archive and restore are idempotent and return 204 without a body. Traces and expenses are retained.
5. Bitrix24 checks restrictions on built-in source changes and permissions. Names and codes in responses are account data.

Typical workflow

1. Read sources and channels.
2. Create a source with a name and UTM source values.
3. Update the source, providing only fields to change.
4. Archive the source and restore it when needed.

Limits

Limit	Value
LimitPage size	Valuelimit: 1 to 500, default 50.
LimitOffset	Valueoffset: nonnegative integer, default 0. One request reads one page.
LimitDomain and UTM source lists	ValueUp to 100 values each, checked by Bitrix24.
LimitName and individual list values	ValueUp to 255 characters, checked by Bitrix24.
LimitSource filter	ValueOnly archived=true or false. No sorting.
LimitChannels	ValueNo filter or sort, with limit and offset.

See also

• Analytics traces
• Keys and authorization
• Errors