Хөрвүүлэлтийн хяналт

Товшилт, лийд, борлуулалт бүртгэх, үйлчлүүлэгч унших.

POST/v1/partners/attribute-referring-partner

Attribute a referring partner (R90). 404 unknown partner, 409 already attributed, 422 when either partner is not approved or they are the same partner.

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

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

Нэр	Төрөл	Тайлбар
`partnerId`	string	The partner being attributed (`par_...`); wins over `tenantId`.
`tenantId`	string
`referredByPartnerId`	string	The referring partner (`par_...`); wins over `referredByTenantId`.
`referredByTenantId`	string
`createCommissionsForPastEvents`	boolean	Also create referral commissions for the partner's eligible past events.

Хариу: 200 AttributeResponse

POST/v1/track/click

Record a click from the destination site and return its click id (R20-R26).

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

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

Нэр	Төрөл	Заавал	Тайлбар
`domain`	string	тийм	Referral domain of the short link.
`key`	string	тийм	Short link key.
`publishableKey`	string		Browser calls only: the workspace's `az_pk_` key.
`trigger`	string		`pageview` records a page visit of the tracked site instead of a link click; omitted or `link` is the ordinary click.

Хариу: 200 ClickResponse

POST/v1/track/lead

Record a lead (R27-R34) or the first step of a deferred lead (R45-R50).

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

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

Нэр	Төрөл	Заавал	Тайлбар
`clickId`	string	тийм	Click id from the `az_id` cookie; the empty string completes a deferred lead (R47).
`eventName`	string	тийм
`customerExternalId`	string	тийм
`customerName`	string
`customerEmail`	string
`customerAvatar`	string
`mode`	null \| LeadMode
`eventQuantity`	integer (int64)		1-100, records the same lead N times (R32).
`metadata`	object
`publishableKey`	string		Browser calls only.

Хариу: 200 null | LeadResponse

POST/v1/track/sale

Record a sale (R35-R44).

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

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

Нэр	Төрөл	Заавал	Тайлбар
`customerExternalId`	string	тийм
`amount`	integer (int64)	тийм	Whole tugrik, `0 ..= 2^53-1`; a JSON number with a fractional part is refused.
`currency`	string		Only `mnt` (default) is accepted.
`eventName`	string
`paymentProcessor`	string
`invoiceId`	string
`metadata`	object
`leadEventName`	string
`clickId`	string
`customerName`	string
`customerEmail`	string
`customerAvatar`	string
`publishableKey`	string
`saleToken`	string		Browser calls only: token minted by `POST /track/sale-token` for this exact sale.

Хариу: 200 SaleResponse

POST/v1/track/sale-token

Mint a short-lived token for one browser-reported sale (secret key only).

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

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

Нэр	Төрөл	Заавал	Тайлбар
`clickId`	string		Click id the browser will send (`""` when the customer already exists).
`customerExternalId`	string	тийм
`amount`	integer (int64)	тийм
`invoiceId`	string	тийм

Хариу: 200 SaleTokenResponse

GET/v1/workspaces/{workspaceId}/conversion-settings

Read the workspace conversion-tracking settings.

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

Параметр (1)

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

Хариу: 200 ConversionSettings

PATCH/v1/workspaces/{workspaceId}/conversion-settings

Update the workspace conversion-tracking settings.

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

Параметр (1)

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

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

Нэр	Төрөл	Тайлбар
`trackingEnabled`	boolean
`trackingHosts`	array	Replaces the whole list: `example.com`, `*.example.com`, `localhost`.
`browserSalesEnabled`	boolean	Turning this on needs the `all` permission (a session or an unrestricted key) and is written to the audit log.
`browserSaleCapMnt`	integer (int64)	Whole MNT, 0 to 9007199254740991. Raising it needs the `all` permission.

Хариу: 200 ConversionSettings

POST/v1/workspaces/{workspaceId}/conversion-settings/publishable-key

Create the workspace's publishable key, or rotate it. Without rotate an existing live key is returned unchanged.

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

Параметр (1)

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

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

Нэр	Төрөл	Заавал	Тайлбар
`rotate`	boolean		Revoke the current key and issue a new one.

Хариу: 200 PublishableKeyResponse

GET/v1/workspaces/{workspaceId}/customers

List customers (R84, cursor pagination).

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

Параметр (14)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`email`	query	string		Exact, case-sensitive; takes precedence over the other filters (R84).
`externalId`	query	string
`search`	query	string		Email, name or external id substring; a `cus_` value matches the id exactly.
`country`	query	string
`linkId`	query	string
`programId`	query	string
`partnerId`	query	string
`includeExpandedFields`	query	boolean
`sortBy`	query	string		createdAt (default), saleAmount, firstSaleAt, subscriptionCanceledAt
`sortOrder`	query	string		desc (default) or asc
`pageSize`	query	integer (int32)
`startingAfter`	query	string
`endingBefore`	query	string

Хариу: 200 Customer[]

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

Get customer.

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

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`customerId`	path	string	тийм	cus_... or ext_<externalId>
`includeExpandedFields`	query	boolean

Хариу: 200 Customer

PATCH/v1/workspaces/{workspaceId}/customers/{customerId}

Update customer.

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

Параметр (3)

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

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

Нэр	Төрөл	Тайлбар
`email`	string
`name`	string
`avatar`	string
`externalId`	string
`stripeCustomerId`	string
`country`	string
`subscriptionCanceledAt`	string	`null` clears.

Хариу: 200 Customer

DELETE/v1/workspaces/{workspaceId}/customers/{customerId}

R86: the customer row goes, lead and sale events stay with their customer id nulled.

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

Параметр (2)

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

Хариу: 200

GET/v1/workspaces/{workspaceId}/leads

Lead events, newest first.

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

Параметр (8)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`customerId`	query	string
`linkId`	query	string
`eventName`	query	string
`invoiceId`	query	string		Sales only: exact invoice id.
`pageSize`	query	integer (int32)
`startingAfter`	query	string
`endingBefore`	query	string

Хариу: 200 LeadItem[]

GET/v1/workspaces/{workspaceId}/sales

Sale events, newest first.

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

Параметр (8)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`customerId`	query	string
`linkId`	query	string
`eventName`	query	string
`invoiceId`	query	string		Sales only: exact invoice id.
`pageSize`	query	integer (int32)
`startingAfter`	query	string
`endingBefore`	query	string

Хариу: 200 SaleItem[]

POST/v1/workspaces/{workspaceId}/sales/{saleId}/refund

Mark a sale refunded (R75-R80). The commission consumer reacts to sale.refunded: pending commissions become refunded, a paid one gets a clawback (R79).

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

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`saleId`	path	string	тийм
`reason`	query	string		`refund` (default), `dispute` or `chargeback`: a disputed or charged-back sale is treated as a refund; the reason only changes the clawback description.

Хариу: 200 SaleItem