GET /milestones

1 min

GET

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

Experimental Get a list of milestones.

Query Parameters

campaign_idstring
Example
63f1c2b675be4132854d2742
Description
Filter milestones by campaign association. When a campaign ID is provided, returns only milestones associated with that campaign. When explicitly set to null, returns only milestones not associated with any campaign. When omitted, returns all milestones regardless of campaign association.
due_date__fromstring<date-time>
Example
2023-10-01T00:00:00Z
Description
Filter milestones with due date from this date, in ISO 8601 UTC format
Format
date-time
due_date__tostring<date-time>
Example
2023-10-31T23:59:59Z
Description
Filter milestones with due date up to this date, in ISO 8601 UTC format
Format
date-time
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 milestones

object
- dataMilestoneResponse[]required
  Description
  List of milestones
  - idstringrequired
    Example
    63f1c2b675be4132854d2741
    Description
    Unique identifier of the milestone
  - titlestringrequired
    Example
    Sample Milestone
    Description
    Title of the milestone
  - colorstringrequired
    Example
    #4ECFD5
    Description
    Color of the milestone label
  - descriptionstringrequired
    Example
    This is a milestone
    Description
    Description of the milestone
  - due_datestring<date-time>required
    Example
    2023-10-07T13:15:30Z
    Description
    Date and time on which the milestone will expire, in ISO 8601 UTC format
    Format
    date-time
  - campaignobjectrequired
    Description
    Campaign associated with the milestone
    - idstringrequired
      Example
      63f1c2b675be4132854d2742
      Description
      Unique identifier of the campaign
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741
      Description
      URL of the milestone
- 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/milestones?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/milestones?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/milestones?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/milestones?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/milestones?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 milestones
{
  "data": [
    {
      "id": "63f1c2b675be4132854d2741",
      "title": "Sample Milestone",
      "color": "#4ECFD5",
      "description": "This is a milestone",
      "due_date": "2023-10-07T13:15:30Z",
      "campaign": {
        "id": "63f1c2b675be4132854d2742"
      },
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741"
      }
    }
  ],
  "pagination": {}
}

401

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

403

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