Шинжилгээ

Нийт дүн, цагийн цуваа, задаргаа, экспорт, хуваалцсан самбар.

GET/v1/workspaces/{workspaceId}/analytics

Totals, timeseries and breakdowns of clicks, leads and sales.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (43)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`event`	query	string		`clicks` (default), `leads`, `sales` or `composite`.
`groupBy`	query	string		See the `groupBy` values of spec 06 4.1; default `count`.
`domain`	query	string
`key`	query	string
`linkId`	query	string
`externalId`	query	string		Value prefixed `ext_`.
`tenantId`	query	string
`tagId`	query	string
`folderId`	query	string
`root`	query	boolean		`true`: root-domain links only; `false`: normal links only.
`partnerId`	query	string
`groupId`	query	string
`partnerTagId`	query	string
`customerId`	query	string
`interval`	query	string		`24h` (default), `7d`, `30d`, `90d`, `1y`, `mtd`, `qtd`, `ytd`, `all`.
`start`	query	string		RFC 3339; overrides `interval`.
`end`	query	string		RFC 3339, exclusive; defaults to now.
`timezone`	query	string		IANA zone name, default `UTC`.
`country`	query	string
`region`	query	string
`city`	query	string
`continent`	query	string
`device`	query	string
`browser`	query	string
`os`	query	string
`trigger`	query	string		`qr`, `link`, `pageview`, `deeplink`.
`referer`	query	string
`refererUrl`	query	string
`url`	query	string
`utm_source`	query	string
`utm_medium`	query	string
`utm_campaign`	query	string
`utm_term`	query	string
`utm_content`	query	string
`eventName`	query	string
`saleType`	query	string		`new` or `recurring`.
`query`	query	string		`metadata['field']:'value'` (leads and sales only).
`page`	query	integer (int32)		Events list: page number, from 1.
`limit`	query	integer (int32)		Events list: page size, default 100, at most 1000.
`sortOrder`	query	string		`asc` or `desc` (default).
`sortBy`	query	string		Events list: `timestamp`. Breakdowns of sales: `saleAmount` ranks by revenue.
`cursor`	query	string		Events list keyset cursor (the `X-Next-Cursor` header of the previous page).

Хариу: 200 object

GET/v1/workspaces/{workspaceId}/analytics/customers

Customers, newest first, with lifetime value.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (6)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`country`	query	string
`linkId`	query	string
`search`	query	string		Matches name, email and external id.
`page`	query	integer (int32)
`pageSize`	query	integer (int32)

Хариу: 200

GET/v1/workspaces/{workspaceId}/analytics/customers/{customerId}

One customer with recent sales and activity.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`customerId`	path	string	тийм

Хариу: 200

POST/v1/workspaces/{workspaceId}/analytics/exports

Queue a CSV export of the current dashboard or events view.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (ExportRequest)

Нэр	Төрөл	Заавал	Тайлбар
`kind`	ExportKind	тийм
`query`	object	тийм	The same parameters as `GET /analytics` (event, interval, filters, ...).

Хариу: 202 ExportJob

GET/v1/workspaces/{workspaceId}/analytics/exports/{exportId}

Status of an export and, once ready, its download link.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`exportId`	path	string	тийм

Хариу: 200 ExportJob

GET/v1/workspaces/{workspaceId}/analytics/exports/{exportId}/download

Download the finished export (zip or CSV).

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`exportId`	path	string	тийм

Хариу: 200

GET/v1/workspaces/{workspaceId}/analytics/shares

Active shares, optionally of one link or folder.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал
`workspaceId`	path	string	тийм
`linkId`	query	string
`folderId`	query	string

Хариу: 200 Share[]

POST/v1/workspaces/{workspaceId}/analytics/shares

Enable sharing of one link or folder.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (CreateShare)

Нэр	Төрөл	Тайлбар
`linkId`	string
`folderId`	string
`showConversions`	boolean
`allowIndex`	boolean
`password`	string	At least 6 characters; stored hashed.

Хариу: 201 Share

PATCH/v1/workspaces/{workspaceId}/analytics/shares/{shareId}

Change options or the password of a share.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`shareId`	path	string	тийм

Хүсэлтийн бие (UpdateShare)

Нэр	Төрөл	Тайлбар
`showConversions`	boolean
`allowIndex`	boolean
`password`	string	Sets a new password.
`clearPassword`	boolean	Removes the password.

Хариу: 200 Share

DELETE/v1/workspaces/{workspaceId}/analytics/shares/{shareId}

Disable sharing: the public URL stops resolving at once and never works again.

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`shareId`	path	string	тийм

Хариу: 204

GET/v1/workspaces/{workspaceId}/events

Raw events, newest first (Business and above).

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (43)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`event`	query	string		`clicks` (default), `leads`, `sales` or `composite`.
`groupBy`	query	string		See the `groupBy` values of spec 06 4.1; default `count`.
`domain`	query	string
`key`	query	string
`linkId`	query	string
`externalId`	query	string		Value prefixed `ext_`.
`tenantId`	query	string
`tagId`	query	string
`folderId`	query	string
`root`	query	boolean		`true`: root-domain links only; `false`: normal links only.
`partnerId`	query	string
`groupId`	query	string
`partnerTagId`	query	string
`customerId`	query	string
`interval`	query	string		`24h` (default), `7d`, `30d`, `90d`, `1y`, `mtd`, `qtd`, `ytd`, `all`.
`start`	query	string		RFC 3339; overrides `interval`.
`end`	query	string		RFC 3339, exclusive; defaults to now.
`timezone`	query	string		IANA zone name, default `UTC`.
`country`	query	string
`region`	query	string
`city`	query	string
`continent`	query	string
`device`	query	string
`browser`	query	string
`os`	query	string
`trigger`	query	string		`qr`, `link`, `pageview`, `deeplink`.
`referer`	query	string
`refererUrl`	query	string
`url`	query	string
`utm_source`	query	string
`utm_medium`	query	string
`utm_campaign`	query	string
`utm_term`	query	string
`utm_content`	query	string
`eventName`	query	string
`saleType`	query	string		`new` or `recurring`.
`query`	query	string		`metadata['field']:'value'` (leads and sales only).
`page`	query	integer (int32)		Events list: page number, from 1.
`limit`	query	integer (int32)		Events list: page size, default 100, at most 1000.
`sortOrder`	query	string		`asc` or `desc` (default).
`sortBy`	query	string		Events list: `timestamp`. Breakdowns of sales: `saleAmount` ranks by revenue.
`cursor`	query	string		Events list keyset cursor (the `X-Next-Cursor` header of the previous page).

Хариу: 200 object[]

GET/v1/workspaces/{workspaceId}/events/stream

Live click stream (Business and above).

Шаардлагатай API түлхүүрийн хамрах хүрээ: analytics.read

Параметр (44)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`event`	query	string		`clicks` (default), `leads`, `sales` or `composite`.
`groupBy`	query	string		See the `groupBy` values of spec 06 4.1; default `count`.
`domain`	query	string
`key`	query	string
`linkId`	query	string
`externalId`	query	string		Value prefixed `ext_`.
`tenantId`	query	string
`tagId`	query	string
`folderId`	query	string
`root`	query	boolean		`true`: root-domain links only; `false`: normal links only.
`partnerId`	query	string
`groupId`	query	string
`partnerTagId`	query	string
`customerId`	query	string
`interval`	query	string		`24h` (default), `7d`, `30d`, `90d`, `1y`, `mtd`, `qtd`, `ytd`, `all`.
`start`	query	string		RFC 3339; overrides `interval`.
`end`	query	string		RFC 3339, exclusive; defaults to now.
`timezone`	query	string		IANA zone name, default `UTC`.
`country`	query	string
`region`	query	string
`city`	query	string
`continent`	query	string
`device`	query	string
`browser`	query	string
`os`	query	string
`trigger`	query	string		`qr`, `link`, `pageview`, `deeplink`.
`referer`	query	string
`refererUrl`	query	string
`url`	query	string
`utm_source`	query	string
`utm_medium`	query	string
`utm_campaign`	query	string
`utm_term`	query	string
`utm_content`	query	string
`eventName`	query	string
`saleType`	query	string		`new` or `recurring`.
`query`	query	string		`metadata['field']:'value'` (leads and sales only).
`page`	query	integer (int32)		Events list: page number, from 1.
`limit`	query	integer (int32)		Events list: page size, default 100, at most 1000.
`sortOrder`	query	string		`asc` or `desc` (default).
`sortBy`	query	string		Events list: `timestamp`. Breakdowns of sales: `saleAmount` ranks by revenue.
`cursor`	query	string		Events list keyset cursor (the `X-Next-Cursor` header of the previous page).
`timeout`	query	integer (int32)		Close the stream after this many seconds (default and maximum 900); clients reconnect with `Last-Event-ID`.

Хариу: 200