POST /pages/{page_id}/events
Create an Event that occurs in the context of a Page, such as measuring clicks
Servers
- https://api.optimizely.com/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
page_id |
Integer | Yes |
The Page ID of the Page you want to create an In-Page Event for |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | No |
The ID of this Event's parent Project |
archived |
Boolean | No |
Whether or not this Event is archived |
description |
String | No |
A description of this Event |
config |
Object | No | |
config.selector |
String | Yes |
CSS selector for the page element(s) that trigger an Event |
id |
Integer | No |
The unique identifier of the Event |
category |
String | No |
Valid values:
|
created |
String | No |
Creation date for this Event |
name |
String | Yes |
A human readable name for this Event |
key |
String | No |
Unique string identifier for this Event within the Project |
event_type |
String | Yes |
The type of this Event Valid values:
|
page_id |
Integer | No |
The Page ID associated with this Event |
is_classic |
Boolean | No |
Whether or not this Event is a classic Event. If true, the Event is read-only Default value: false |
is_editable |
Boolean | No |
Whether or not this Event may be edited |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.