Log an event

Log an analytics event

Header Parameters

User-Agent string required

application/json

Request Body required

domain string required

Domain of site

name string required

Name of event to log.

url uri required

URL of page that triggered event

referrer string

Referrer for this event

props object

Custom properties for the event. Note maximum of 30 key value pairs. If more than 30 are provided the exceeding keys will be ignored.

Responses

text/plain

Schema

Example

Schema

string

{
  "value": "ok"
}

Request was invalid or malformed

application/json

Schema

Example (from schema)

Example

Schema

oneOf

GeneralError

BadRequest

code integer

HTTP response code

message string

Human readable error message

{}

{
  "code": 400,
  "message": "Request was malformed",
  "fields": [
    {
      "field": "email",
      "condition": "email"
    },
    {
      "field": "name",
      "condition": "required"
    }
  ]
}

The rate limit has been exceeded

Response Headers

Retry-After integer
Number of seconds until the client should retry the request

application/json

Schema

Example (from schema)

Example

Schema

code integer

HTTP response code

message string

Human readable error message

{
  "code": 0,
  "message": "string"
}

{
  "code": 429,
  "message": "Too many requests"
}

An unexpected server error

application/json

Schema

Example (from schema)

Example

Schema

code integer

HTTP response code

message string

Human readable error message

{
  "code": 0,
  "message": "string"
}

{
  "code": 500,
  "message": "Unexpected error"
}

Log an event​

Log an event