Sign in
latestOpenAPI 3.1.02026-08-1021368.3 KB

50679caad756

Events

Create event

Create an event.

Permissions: Requires write access to the site (manage:{site_id}).

Returns: An event object.

post/sites/{site_id}/events

Path parameters

site_idstring required
Example:CDBUGS

The ID of the site. This is the same string you use in your tracking code. Example: CDBUGS

Request body

namestring required

The name of the event (up to 255 characters). Example: Purchase early access

currency'dollar' | 'pound' | 'euro' | 'yuan' | 'peso' | 'shekel' | 'yen' | 'won' | 'hryvnia' | 'franc' | 'rupee' | 'integer' | 'none'

The currency used for any value attached to this event's completions. If omitted, defaults to dollar.

Example request

{
  "name": "Purchase early access"
}

Response

Successful response