Хөтөлбөрийн шинжилгээ

Түнш хөтөлбөрийн тайлан.

GET/v1/workspaces/{workspaceId}/programs/analytics/applications

Application analytics: funnel, daily series, sources, countries.

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

Параметр (11)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`groupBy`	query	string		`funnel` (default), `timeseries`, `sources`, `countries`.
`partnerId`	query	string		The applicant partner.
`groupId`	query	string
`source`	query	string		Comma list of source kinds.
`country`	query	string		Comma list of ISO country codes (visit country).
`interval`	query	string
`start`	query	string
`end`	query	string
`timezone`	query	string
`view`	query	string		`cohort` (default) or `activity` (R27).

Хариу: 200 object

GET/v1/workspaces/{workspaceId}/programs/analytics/breakdown

One "top views" card (R6), 100 rows at most.

Шаардлагатай 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).
`dim`	query	string	тийм	A breakdown of spec 06 4.1: `top_links`, `top_urls`, `referers`, `utm_sources`, `continents`, `countries`, `regions`, `cities`, `devices`, `browsers`, `os`, `triggers`.

Хариу: 200 object[]

GET/v1/workspaces/{workspaceId}/programs/analytics/commissions

Commission analytics: a time series of value and count, a per-partner table, and top views by group, type and status (R21).

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

Параметр (12)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`groupBy`	query	string		`timeseries` (default), `partners`, `groups`, `types`, `status`.
`partnerId`	query	string
`groupId`	query	string
`partnerTagId`	query	string
`type`	query	string
`status`	query	string
`interval`	query	string
`start`	query	string
`end`	query	string
`timezone`	query	string
`metric`	query	string		`value` (default) or `count`: only decides the default ordering of tables.

Хариу: 200 object[]

GET/v1/workspaces/{workspaceId}/programs/analytics/commissions/forecast

Release forecast of pending commissions (R24) and the next payout estimate (R25).

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

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`days`	query	integer (int32)		1 to 90 (default 90).

Хариу: 200 ForecastDto

GET/v1/workspaces/{workspaceId}/programs/analytics/commissions/summary

The status cards of R23: always "now", except the paid card (range of paid_at).

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

Параметр (5)

Нэр	Байрлал	Төрөл	Заавал
`workspaceId`	path	string	тийм
`interval`	query	string
`start`	query	string
`end`	query	string
`timezone`	query	string

Хариу: 200 SummaryDto

POST/v1/workspaces/{workspaceId}/programs/analytics/export

Start the export; the download link is emailed and valid for 7 days (202).

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

Параметр (1)

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

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

Нэр	Төрөл	Тайлбар
`columns`	array	Columns in order; default `shortLink, url, clicks, createdAt`.
`from`	string (date-time)	Only links created at or after / before these instants.
`to`	string (date-time)
`filters`	null \| Filters

Хариу: 202 ExportStarted

GET/v1/workspaces/{workspaceId}/programs/analytics/exports/{jobId}/download

Download a finished export (ZIP).

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

Параметр (2)

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

Хариу: 200

GET/v1/workspaces/{workspaceId}/programs/analytics/groups

Group comparison (R8).

Шаардлагатай 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 GroupPerf[]

GET/v1/workspaces/{workspaceId}/programs/analytics/overview

KPIs, funnel and time series of the program (R2, R3, R15).

Шаардлагатай 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 OverviewDto

GET/v1/workspaces/{workspaceId}/programs/analytics/partners

Partner table (R7): metrics, rates and EPC per partner, 100 rows.

Шаардлагатай 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).
`orderBy`	query	string		`commissions` (default), `clicks`, `leads`, `sales`, `saleAmount`, `epc`, `name`.

Хариу: 200 PartnerPerf[]