Sign in

v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Get report

Run and send a report configured in the Orange Logic interface

get/getreport_4103_v1

Query parameters

IDstring required

The <a href="https://developer.orangelogic.com/reference/reports#find-a-report-id">report ID</a>.

OutputFormat'CSV' | 'XML' | 'PDF' required

The format of the report.

SavedSearchIDstring

The <a href="https://developer.orangelogic.com/reference/reports#find-a-saved-search-id">saved search ID</a>.

Filtersstring

The filters to apply to the data collected by the report. Use the format <code>filter ID=filter value</code>. Enter multiple filters as a comma separated list.<p><strong>Example</strong>: Enter <code>AC_ContactGroup=Admin,HasLoginBetween_From=01-01-2025</code> to generate a report of users in the <strong>Admin</strong> group who have logged in since January 1, 2025.<p>Use the <a href="https://developer.orangelogic.com/reference/get-report-information">Get report information</a> call to retrieve the available filters for a specific report.

Columnsstring

The columns of data included in the report. Use the <a href="https://developer.orangelogic.com/reference/get-report-information">Get report information</a> 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.

ReportTitlestring

The title of the report.<p>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.

ReportDescriptionstring

Enter a description of the report.<p>This text is used only when the <code>OutputForm</code> parameter is set to <code>PDF</code>.

SendByEmailboolean
<ul><li><code>false</code>: The report is generated but not sent to anyone.</li><li><code>true</code>: The generated report is automatically emailed to address in the <code>EmailAddress</code> parameter.</li><ul>
EmailAddressstring

The address the report is sent to when the <code>SendByEmail</code> parameter is set to <code>true</code>.

Encodingstring

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

UseServerTimezonestring
<ul><li><code>false</code>: The user’s timezone determines the timestamp of the report.</li><li><code>true</code>: The server timezone determines the timestamp of the report.</li></ul>

Response

200

{"stackTrail":"paths:/getreport_4103_v1:get:responses:200:content:application/json:schema:properties:downloadURL","oasType":"schema","type":"unknown"}
messagestring

Example response

{
  "message": "The report file will be sent over email when the export completed"
}