Retrieve changes for a project.

1 min

GET

https://api.optimizely.com/v2/changes

Get a list of changes for a given project using optional filters.

Query Parameters

project_idinteger<int64>required
Description
ID of the Project you want to list changes for.
Format
int64
idinteger[]
Description
A specific Change ID to filter by. Can be specified multiple times to include multiple specific changes.
start_timestring<date-time>
Description
Start of the time interval (inclusive) to list changes. The time is formatted in ISO 8601.
Format
date-time
end_timestring<date-time>
Description
End of the time interval (exclusive) to look for changes. The time is formatted in ISO 8601.
Format
date-time
userstring[]
Description
Email of the user who made the change. Can be specified multiple times to include changes from multiple users.
entity_typestring[]
Description
The type of the entity. The entity_type must be one of the following : attribute, audience, campaign, environment, event, experiment, extension, feature, flag, group, list_attribute, metrics, page, project, report, rule, ruleset, section, tag, variation, variable, permission, team. Can be specified multiple times to include changes for multiple entity types.
sourcestring
Description
The source of the change (UI or API)
entitystring[]
Description
Colon (:) delimited string containing the entity_type and entity_id of the entity wanted. The entity_type must be one of the following : attribute, audience, campaign, environment, event, experiment, extension, feature, flag, group, list_attribute, metrics, page, project, report, rule, ruleset, section, tag, variation, variable, permission e.g. ruleset
, experiment
. Can be specified multiple times to filter changes to a specific set of entities.
per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.
Default
1

Responses

200Returns changes.

ChangeHistoryChange[]
- change_typestring<archive | create | update | delete | publish>
  Description
  Action performed on the entity.
  Allowed
  archivecreateupdatedeletepublish
- changesChangeDetail[]
  Description
  List of change details.
  - after
    Description
    Value of the property after modification.
  - before
    Description
    Value of the property before modification.
  - descriptionstring
    Description
    Human readable description of the change.
  - propertystring
    Description
    The name of the property modified.
- createdstring<date-time>
  Description
  Created time of the current revision. Format is ISO 8601.
  Format
  date-time
- entityEntity
  - api_urlstring<url>
    Description
    Generated URL to access the entity by using the public API.
    Format
    url
  - idinteger<int64>
    Description
    ID of the entity.
    Format
    int64
  - namestring
    Description
    Name of the entity.
  - sub_typestring
    Description
    Optional field for entities that have sub_types (projects, experiments, extensions, pages, etc)
  - typestring
    Description
    Type of the entity as defined by the public API.
  - ui_urlstring<url>
    Description
    Generated URL to access the entity using Optimizely UI.
    Format
    url
- idinteger<int64>
  Description
  ID of the change.
  Format
  int64
- project_idinteger<int64>required
  Description
  ID of the project related to the entity.
  Format
  int64
- revisionsChangeRevision
  - currentRevision
    - idinteger
      Description
      Reference to a revision of the entity.
  - previousRevision
    - idinteger
      Description
      Reference to a revision of the entity.
- sourcestring<ui | api>
  Description
  Origin of the current revision.
  Allowed
  uiapi
- summarystring
  Description
  Short human readable description of the change.
- userUser
  - display_namestring
    Description
    Display name of the user, most commonly the Optimizely user's email.
  - emailstringrequired
    Description
    Email of the user.
  - first_namestring
    Description
    First name of the user.
  - idstringrequired
    Description
    ID of the user.
  - last_namestring
    Description
    Last name of the user.
  - profile_image_urlstring
    Description
    URL to the user profile image.

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/changes?project_id=integer%3Cint64%3E&per_page=25&page=1' \
     --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.optimizely.com/v2/changes?project_id=integer<int64>&per_page=25&page=1", 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.optimizely.com/v2/changes?project_id=integer<int64>&per_page=25&page=1")

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.optimizely.com/v2/changes?project_id=integer<int64>&per_page=25&page=1"

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

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

print(response.text)

200

// Returns changes.
[
  {
    "change_type": "",
    "changes": [
      {
        "after": "",
        "before": "",
        "description": "",
        "property": ""
      }
    ],
    "created": "",
    "entity": {
      "api_url": "",
      "id": "",
      "name": "",
      "sub_type": "",
      "type": "",
      "ui_url": ""
    },
    "id": "",
    "project_id": "",
    "revisions": {
      "current": {
        "id": 0
      },
      "previous": {
        "id": 0
      }
    },
    "source": "",
    "summary": "",
    "user": {
      "display_name": "",
      "email": "",
      "first_name": "",
      "id": "",
      "last_name": "",
      "profile_image_url": ""
    }
  }
]