GET /events

1 min

GET

https://api.cmp.optimizely.com/v3/events

Experimental Get a list of events.

Query Parameters

start_datestring
Example
2024-11-24T00:00:00.000Z
Description
ISO date string - filters events with end_date >= start_date
end_datestring
Example
2024-11-26T00:00:00.000Z
Description
ISO date string - filters events with start_date <= end_date
campaign_idstring
Example
66d953340019d7b86833ac6d
Description
Single campaign ID - filters events by campaign
offsetinteger
Example
5
Description
Starting index of results (zero indexed)
Default
0
Minimum
0
page_sizeinteger
Example
15
Description
Number of results to return per page
Default
10
Minimum
1
Maximum
100

Responses

200List of fetched events

object
- dataEventResponse[]required
  Description
  List of events
  - idstringrequired
    Example
    674ea40a7a9cac80ff78c95c
    Description
    Unique identifier of the event
  - titlestringrequired
    Example
    The awesome event
    Description
    Title of the event
  - descriptionstringrequired
    Example
    The awesome event's description
    Description
    Description of the event
  - campaign_idstringrequired
    Example
    66d953340019d7b86833ac6dg
    Description
    Unique identifier of the campaign associated with the event
  - start_datestringrequired
    Example
    2024-11-26T11:00:34Z
    Description
    Start date of the event in ISO 8601 UTC format
  - end_datestringrequired
    Example
    2024-11-26T11:30:34Z
    Description
    End date of the event in ISO 8601 UTC format
  - is_all_daybooleanrequired
    Description
    Whether the event is a day long event or not
  - is_archivedbooleanrequired
    Description
    Whether the event is archived or not
  - created_bystringrequired
    Example
    66d837c62373533177b59db3
    Description
    Unique identifier of the user who created the event
  - reference_idstringrequired
    Example
    EVT-3
    Description
    Reference ID of the event
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/events/674ea40a7a9cac80ff78c95c
      Description
      URL of the event
    - campaignstringrequired
      Example
      https://api.cmp.optimizely.com/v3/campaigns/66d953340019d7b86833ac6d
      Description
      URL of the campaign associated with the event
- paginationobjectrequired
  - Pagination
    - nextstringrequired
      Example
      https://api.cmp.optimizely.com/<some-path-to-next-page>?offset=10&page_size=10
      Description
      URL to the next page
    - previousstringrequired
      Description
      URL to the previous page
  - object
    - nextstring
      Example
      https://api.cmp.optimizely.com/v3/events?offset=10&page_size=10

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url 'https://api.cmp.optimizely.com/v3/events?offset=5&page_size=10' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/events?offset=5&page_size=10", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/events?offset=5&page_size=10")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/events?offset=5&page_size=10"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// List of fetched events
{
  "data": [
    {
      "id": "674ea40a7a9cac80ff78c95c",
      "title": "The awesome event",
      "description": "The awesome event's description",
      "campaign_id": "66d953340019d7b86833ac6dg",
      "start_date": "2024-11-26T11:00:34Z",
      "end_date": "2024-11-26T11:30:34Z",
      "is_all_day": false,
      "is_archived": false,
      "created_by": "66d837c62373533177b59db3",
      "reference_id": "EVT-3",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/events/674ea40a7a9cac80ff78c95c",
        "campaign": "https://api.cmp.optimizely.com/v3/campaigns/66d953340019d7b86833ac6d"
      }
    }
  ],
  "pagination": {}
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}