---
updatedAt: 2026-07-30T11:03:58.000Z
agentTools:
  projectIndex: https://developer.orangelogic.com/llms.txt
---

# Get report

Run and send a report configured in the Orange Logic interface

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "report",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://{OrangeLogicURL}/webapi/report/export",
      "variables": {
        "OrangeLogicURL": {
          "default": "OrangeLogicURL"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://example.com/oauth2/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/getreport_4103_v1": {
      "get": {
        "summary": "Get report",
        "description": "Run and send a report configured in the Orange Logic interface",
        "operationId": "get-reports",
        "parameters": [
          {
            "name": "ID",
            "in": "query",
            "description": "The <a href=\"https://developer.orangelogic.com/reference/reports#find-a-report-id\">report ID</a>.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "OutputFormat",
            "in": "query",
            "description": "The format of the report.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "CSV",
                "XML",
                "PDF"
              ]
            }
          },
          {
            "name": "SavedSearchID",
            "in": "query",
            "description": "The <a href=\"https://developer.orangelogic.com/reference/reports#find-a-saved-search-id\">saved search ID</a>.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Filters",
            "in": "query",
            "description": "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.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Columns",
            "in": "query",
            "description": "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.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ReportTitle",
            "in": "query",
            "description": "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.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ReportDescription",
            "in": "query",
            "description": "Enter a description of the report.<p>This text is used only when the <code>OutputForm</code> parameter is set to <code>PDF</code>.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "SendByEmail",
            "in": "query",
            "description": "<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>",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "EmailAddress",
            "in": "query",
            "description": "The address the report is sent to when the <code>SendByEmail</code> parameter is set to <code>true</code>.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Encoding",
            "in": "query",
            "description": "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>.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "UseServerTimezone",
            "in": "query",
            "description": "<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>",
            "schema": {
              "type": "string",
              "default": "false"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"downloadURL\": null,\n    \"message\": \"The report file will be sent over email when the export completed\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "downloadURL": {},
                    "message": {
                      "type": "string",
                      "example": "The report file will be sent over email when the export completed"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "curl",
              "code": "curl --location 'https://mangovations.com/webapi/report/export/getreport_4103_v1?OutputFormat=PDF&ReportTitle=Active%20contacts%20in%20the%20past%20week&SendByEmail=true&EmailAddress=jennifer.smith%40mangovations.com&ReportDescription=Users%20who%20logged%20in%20and%20edited%20assets%20within%20the%20past%207%20days.&SavedSearchID=K9I1UQSIC8&Filters=ContactType&Columns=Contact_type%2CLoginID%2CLastLoginDate%2CStatus&UseServerTimezone=true&ID=ActiveContact' \\\n--header 'Authorization: Bearer b9PaUGhHYMOkJKjbeEgUdtQpEwAX1fJa3@njjgpCHSEWCu9kDg1P4Gb6jy.aNMclaqBfavEi29pnn3RYUzUGG2eLS1YYIN6noyvUBOeF9Q.4zCMznewm7EDrCZq@X8U7' \\\n--header 'Cookie: CTL-Session__1505=CfDJ8FrqgvJ5XBlPkZUlnKu6VMNsM%2FrM5MVQzdLiNzWOg3ZbM0U7S2XPjXZXEToYxFDwTmX%2FVrSswpk7Tm4PmR1uf935Bl1ce8vkOVzWgNfA8%2BjokcQRuzIvTfEnA5gC1uoarAIwHbnupIQxvz0b0y4JACxLSp34cCUM6Vws37T4H%2Fb0; CTL-Session__1505-Alt=CfDJ8FrqgvJ5XBlPkZUlnKu6VMNsM%2FrM5MVQzdLiNzWOg3ZbM0U7S2XPjXZXEToYxFDwTmX%2FVrSswpk7Tm4PmR1uf935Bl1ce8vkOVzWgNfA8%2BjokcQRuzIvTfEnA5gC1uoarAIwHbnupIQxvz0b0y4JACxLSp34cCUM6Vws37T4H%2Fb0'"
            }
          ],
          "samples-languages": [
            "curl"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```