XExentral
Report

Create report export

Create an export for given report based on the SQL statement that is stored with the report. You can overwrite the stored query parameters by passing new parameters in the request body

post/api/v1/analytics/report/{id}/export

Request

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Request body

Example request

{
  "parameters": [
    {
      "name": "date",
      "type": "string",
      "defaultValue": "2021-01-01"
    }
  ]
}

Response

Query execution response

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "query": "SELECT * FROM users",
      "url": "https://example.com",
      "error": "SQL statement is invalid",
      "exportFormat": "txt",
      "createdAt": "2023-01-01T00:00:00+00:00",
      "updatedAt": "2023-01-01T00:00:00+00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.