Archive Reports

1 min

POST

https://api.optimizely.com/flags/v1//projects/{project_id}/environments/{environment_key}/reports/archived

Archive one or more Reports in an Environment of a Project.

This operation corresponds to the archive_url in a Reports response.

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier
environment_keystringrequired
Example
production
Description
The Environment identifier

Body Parameters

bodyBulkOperationsRequestBodyrequired
Example
```
{
  "keys": [
    "landing_page_callout_N6JU6FJ2YiMdujucr6R6uf"
  ]
}
```
- keysstring[]
  Description
  The list of resource keys to perform the desired operation

Responses

200

Successful archive of Reports.

The response includes RESTful JSON (https://restfuljson.org/) styled links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

ReportMap

Example

{
  "landing_page_callout_N6JU6FJ2YiMdujucr6R6uf": {
    "archived": true,
    "created_time": "2021-02-03T19:57:31.418350+00:00",
    "delete_url": "/projects/23004/environments/development/reports/landing_page_callout_kK2mpgdxRMRRXx6dZkFLsB",
    "description": null,
    "fetch_flag_url": "/projects/23004/flags/recurring_deposit",
    "fetch_results_api_url": "https://api.develrc-app.optimizely.com/experiments/9000000010001/results",
    "fetch_results_ui_url": "https://app.optimizely.test/v2/projects/23004/results/9000000010001/experiments/9000000010001",
    "flag_key": "recurring_deposit",
    "flag_name": "Recurring Deposit",
    "flag_state": "unarchived",
    "id": 1,
    "key": "landing_page_callout_N6JU6FJ2YiMdujucr6R6uf",
    "name": "Landing Page Callout",
    "reset_results_url": "/projects/23004/environments/development/reports/landing_page_callout_kK2mpgdxRMRRXx6dZkFLsB/reset-results",
    "rule_key": "landing_page_callout",
    "rule_name": "Landing Page Callout",
    "rule_state": "enabled",
    "start_time": "2021-02-03T21:52:58.603598+00:00",
    "type": "a/b",
    "unarchive_url": "/projects/23004/environments/development/reports/unarchived",
    "updated_time": "2021-02-03T21:53:01.735777+00:00",
    "url": "/projects/23004/environments/development/reports/landing_page_callout_kK2mpgdxRMRRXx6dZkFLsB",
    "urn": "reports.flags.optimizely.com::1"
  }
}

Description

Map of reports that include report key as key and report payload as value.

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

404Not found. No content

409Conflicting resource state with requested action

curl

curl --request POST \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/environments/{environment_key}/reports/archived \
     --header 'accept: application/json'

javascript

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

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

fetch("https://api.optimizely.com/flags/v1//projects/{project_id}/environments/{environment_key}/reports/archived", 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/flags/v1//projects/{project_id}/environments/{environment_key}/reports/archived")

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

request = Net::HTTP::Post.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/flags/v1//projects/{project_id}/environments/{environment_key}/reports/archived"

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

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

print(response.text)

200

// Successful archive of Reports.
The response includes RESTful JSON (https://restfuljson.org/) styled links. If a
link is not present in the response, it indicates a user is not authorized to access
the related resource.
{}

400

// Malformed requests and invalid parameter names and types

401

// Invalid credentials

403

// Do not have permission to perform the operation

404

// Not found. No content

409

// Conflicting resource state with requested action