Get report

Run and send a report configured in the Orange Logic interface

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
string
enum
required

The format of the report.

Allowed:
string
string

The filters to apply to the data collected by the report. Use the format filter ID=filter value. Enter multiple filters as a comma separated list.

Example: Enter AC_ContactGroup=Admin,HasLoginBetween_From=01-01-2025 to generate a report of users in the Admin group who have logged in since January 1, 2025.

Use the Get report information call to retrieve the available filters for a specific report.

string

The columns of data included in the report. Use the Get report information call to retrieve the available columns for a specific report. Leave this parameter blank to use all columns that are currently visible in the Orange Logic interface.

string

The title of the report.

This title is used in the output file and as the header in PDFs. This title doesn’t need to match the report title used in the Orange Logic interface.

string

Enter a description of the report.

This text is used only when the OutputForm parameter is set to PDF.

boolean
Defaults to false
  • false: The report is generated but not sent to anyone.
  • true: The generated report is automatically emailed to address in the EmailAddress parameter.
    string

    The address the report is sent to when the SendByEmail parameter is set to true.

    string

    The specific character encoding scheme, such as UTF-8, used when the OutputForm parameter is set to CSV or XML.

    string
    Defaults to false
    • false: The user’s timezone determines the timestamp of the report.
    • true: The server timezone determines the timestamp of the report.
    Response

    Language
    Credentials
    OAuth2
    URL
    LoadingLoading…
    Response
    Choose an example:
    application/json