Model: Reports

1 min

Model Parameters

Reports
- countintegerrequired
  Example
  1
  Description
  Number of Reports on the current page.
- fetch_report_urlobject
  Description
  A url template to be used to find a particular Report.
  - UrlValue
- filter_urlobject
  Description
  Link to the default page of Reports with filter '.../{?filter}'
  - UrlValue
- first_urlobjectrequired
  Description
  Link to first page of Reports in a series.
  - UrlValue
- itemsReport[]required
  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
- last_urlobjectrequired
  Description
  Link to the last page of Reports in a series.
  - UrlValue
- next_urlobject
  Description
  List of links to next pages of Reports in a series.
  
  The first element in the array is the exact next page after the current record, etc.
  - UrlList
- pageintegerrequired
  Example
  1
  Description
  Number of the current page. 1-index based.
- prev_urlobject
  Description
  List of links to previous pages of Reports in a series.
  
  The first element in the array is the exact previous page before the current record, etc.
  - UrlList
- reset_urlobject
  Description
  Link to the default page of Reports
  - UrlValue
- sort_urlobject
  Description
  Link to the default page of Reports with sort '.../{?sort}'
  - UrlValue
- total_countintegerrequired
  Example
  1
  Description
  Total number of Reports.
- total_pagesintegerrequired
  Example
  1
  Description
  Total number of pages for this series.
- urlobjectrequired
  Description
  Link to self
  - UrlValue

Summary of the Reports for Flags in a project