Send product events from your server

post/analytics/events

Send product events from your server: a name, a few properties, your own id for the person (only a one-way digest of it is kept, tied to the day unless the person agreed) and whether they agreed. Values that look like an email address or a phone number are dropped.

Before you call

Credential: Authorization: Bearer $KEY
Scope: analytics:write
Mcp: rivier_analytics_events_send
Graphql: Mutation.analyticsEventSend
Sdk: analytics.event.send
Cli: analytics event send

Request bodyapplication/json, required

eventslist of objectrequired
- namestringrequired
  Pattern: ^[A-Za-z][A-Za-z0-9_.:-]{0,59}$.
- anonymousIdstringrequired
  Your own id for the person; it is never stored, only a one-way digest of it At most 120 characters.
- propertiesobject
- consentboolean
  The person agreed to be recognised from one day to the next
- atstring (date-time)
  When it happened; up to seven days back

Responses

202application/json
Success
- acceptednumberrequired
- droppedlist of objectrequired
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/events' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "events": [
    {
      "name": "string",
      "anonymousId": "string"
    }
  ]
}'

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

This page as Markdown