Fetch a Single Report

1 min

GET

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

Fetch a single Report in an Environment of a Project by its key.

This operation corresponds to the fetch_report_url in a Report response.

Path Parameters

project_idintegerrequired
Example
12345
Description
The project identifier
environment_keystringrequired
Example
production
Description
The Environment identifier
report_keystringrequired
Example
paid_users_45633910
Description
The Report identifier. Get the key from the List Reports endpoint (key is not displayed in the Optimizely app)

Responses

200

Successful retrieval of a Report.

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.

Report
Description
Report with results for the active rule for a flag in a project.
- archive_urlobject
  Description
  Link to archive this Report
  - UrlValue
- archivedboolean
  Description
  Indicates if the Report is archived or not
- created_timestring<date-time>required
  Example
  2019-05-08T00:00:00.000Z
  Description
  Timestamp when the Report is created
  Format
  date-time
- delete_urlobject
  Description
  Link to delete this Report
  - UrlValue
- descriptionstring
  Example
  Detailed context about the report is here.
  Description
  Additional context of the Report
- distribution_modestring<manual | stats_accelerator>
  Description
  Type of rule distribution
  Allowed
  manualstats_accelerator
- end_timestring<date-time>
  Example
  2019-05-08T00:00:00.000Z
  Description
  Timestamp until when the Report is computed
  Format
  date-time
- fetch_flag_urlobject
  Description
  Link to flag url to which this report belongs to
  - UrlValue
- fetch_results_api_urlobject
  Description
  Link to the results API associated with this Report
  - UrlValue
- fetch_results_ui_urlobject
  Description
  Link to the results UI associated with this Report
  - UrlValue
- flag_keystringrequired
  Example
  recurring_deposit
  Description
  The Key of the Flag this report belongs to
- flag_namestring
  Example
  Recurring Deposit
  Description
  The Name of the Flag this report belongs to
- flag_statestring<enabled | disabled | unarchived | archived | deleted>
  Example
  unarchived
  Description
  State of the Flag this report belongs to
  Allowed
  enableddisabledunarchivedarchiveddeleted
- idintegerrequired
  Example
  45633910
  Description
  System generated Unique ID of the Report
- keystringrequired
  Example
  paid_users-45633910
  Description
  User-facing Unique identifier of the Report. Same as rule key with report ID appended.
- layer_experiment_idinteger
  Description
  Experiment ID or Layer Experiment of a rule
- namestringrequired
  Example
  Paid Users
  Description
  User-facing name of the Report. Same as rule name.
- primary_metricstring
  Example
  conversion_rate
  Description
  The first metric in the list of metrics.
- reset_results_urlobject
  Description
  Link to reset results associated with this Report
  - UrlValue
- revisioninteger
  Description
  Revision number for tracking changes
- rolestring
  Example
  admin
  Description
  Granular permission role
- rule_descriptionstring
  Example
  Paid Users description
  Description
  The description of the Rule this report belongs to
- rule_keystringrequired
  Example
  paid_users
  Description
  The Key of the Rule this report belongs to
- rule_namestring
  Example
  Paid Users
  Description
  The Name of the Rule this report belongs to
- rule_statestring
  Example
  deleted
  Description
  State of the Rule this report belong to
- start_timestring<date-time>
  Example
  2019-05-08T00:00:00.000Z
  Description
  Timestamp from when the Report is computed
  Format
  date-time
- typestring<a/b | multi_armed_bandit | feature_rollout>required
  Example
  a/b
  Description
  Type of report.
  Allowed
  a/bmulti_armed_banditfeature_rollout
- unarchive_urlobject
  Description
  Link to unarchive this Report
  - UrlValue
- updated_timestring<date-time>required
  Example
  2019-05-08T00:00:00.000Z
  Description
  Timestamp when the Report is last updated
  Format
  date-time
- urlobjectrequired
  Description
  Link to self
  - UrlValue
- urnstringrequired
  Example
  reports.flag.optimizely.com::45633910
  Description
  The URN for the Report

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

404Not found. No content

curl

curl --request GET \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/environments/{environment_key}/reports/{report_key} \
     --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/flags/v1//projects/{project_id}/environments/{environment_key}/reports/{report_key}", 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/{report_key}")

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/flags/v1//projects/{project_id}/environments/{environment_key}/reports/{report_key}"

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

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

print(response.text)

200

// Successful retrieval of a Report.
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.
{
  "archive_url": {},
  "archived": false,
  "created_time": "2019-05-08T00:00:00.000Z",
  "delete_url": {},
  "description": "Detailed context about the report is here.",
  "distribution_mode": "",
  "end_time": "2019-05-08T00:00:00.000Z",
  "fetch_flag_url": {},
  "fetch_results_api_url": {},
  "fetch_results_ui_url": {},
  "flag_key": "recurring_deposit",
  "flag_name": "Recurring Deposit",
  "flag_state": "unarchived",
  "id": 45633910,
  "key": "paid_users-45633910",
  "layer_experiment_id": 0,
  "name": "Paid Users",
  "primary_metric": "conversion_rate",
  "reset_results_url": {},
  "revision": 0,
  "role": "admin",
  "rule_description": "Paid Users description",
  "rule_key": "paid_users",
  "rule_name": "Paid Users",
  "rule_state": "deleted",
  "start_time": "2019-05-08T00:00:00.000Z",
  "type": "a/b",
  "unarchive_url": {},
  "updated_time": "2019-05-08T00:00:00.000Z",
  "url": {},
  "urn": "reports.flag.optimizely.com::45633910"
}

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