Analytics site transaction record

post/analytics/site/transactions

Record an outcome from the project's own records (a form, booking, order, review or chat) with the source class that travelled with it. Used by the modules that hold those records.

Before you call

Credential: Authorization: Bearer $KEY
Scope: analytics:write
Graphql: Mutation.analyticsSiteTransactionRecord
Sdk: analytics.siteTransaction.record
Cli: analytics site transaction record

Request bodyapplication/json, required

projectstring
At most 80 characters.
kindstringrequired
One of: form, booking, order, review, chat.
sourcestring
One of: ai, search, social, email, paid, referral, direct, unknown.
itemstring
At most 80 characters.
pagestring
At most 200 characters.
valueMinorinteger
At least 0.
currencystring
At most 3 characters.
canaryboolean
visitorstring
At most 40 characters.

Responses

201application/json
Success
object
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/analytics/site/transactions' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "form"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown