Search for events belonging to your organization.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  events: [
    {
      "id": 8192
      "event_type": "fullscreen",
      "html": "<div class=\"main\">Checkout my CTA!</div>"
      ...
    },
    {
      "id": 9297
      "event_type": "fullscreen",
      "html": "<div class=\"main\">Checkout my CTA!</div>"
      ...
    }
  ],
  summary: {
    page: 1,
    per_page: 20,
    count: 2
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

per_page
optional

The number of items to show per page
:Maximum => 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.

query
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
A string used to search for a set of events by name

Validations:

  • Must be a String

type
optional

Filter the type of event to return

Validations:

  • Must be a String