List Reports

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

Get a list of Reports for a specific Environment of a project

You can use query parameters to filter/sort the response.

Recipes

🔍

9. Analyze results

Open Recipe

Responses

Response body

object

count

integer

required

Number of Reports on the current page.

fetch_report_url

string

A single url.

filter_url

string

A single url.

first_url

string

required

A single url.

items

array of objects

required

items*

object

archive_url

string

A single url.

archived

boolean

Indicates if the Report is archived or not

created_time

date-time

required

Timestamp when the Report is created

delete_url

string

A single url.

description

string

Additional context of the Report

end_time

date-time

Timestamp until when the Report is computed

fetch_flag_url

string

A single url.

fetch_results_api_url

string

A single url.

fetch_results_ui_url

string

A single url.

flag_key

string

required

The Key of the Flag this report belongs to

flag_name

string

The Name of the Flag this report belongs to

integer

required

System generated Unique ID of the Report

key

string

required

User-facing Unique identifier of the Report. Same as rule key with report ID appended.

name

string

required

User-facing name of the Report. Same as rule name.

reset_results_url

string

A single url.

revision

integer

Revision number for tracking changes

role

string

Granular permission role

rule_description

string

The description of the Rule this report belongs to

rule_key

string

required

The Key of the Rule this report belongs to

rule_name

string

The Name of the Rule this report belongs to

rule_state

string

State of the Rule this report belong to

start_time

date-time

Timestamp from when the Report is computed

type

string

required

Type of report.

a/b multi_armed_bandit

unarchive_url

string

A single url.

updated_time

date-time

required

Timestamp when the Report is last updated

url

string

required

A single url.

urn

string

required

The URN for the Report

last_url

string

required

A single url.

next_url

array of strings

A list of urls.

next_url

page

integer

required

Number of the current page. 1-index based.

prev_url

array of strings

A list of urls.

prev_url

reset_url

string

A single url.

sort_url

string

A single url.

total_count

integer

required

Total number of Reports.

total_pages

integer

required

Total number of pages for this series.

url

string

required

A single url.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.optimizely.com/flags/v1/projects/project_id/environments/environment_key/reports \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

List Reports

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation