---
title: "Retrieve data for report(s)"
method: GET
path: "/report"
tags: ["Report"]
---

# Retrieve data for report(s)

`GET /report`

## Request

- Base URL: `https://api.zentail.com/v1`
- URL: `https://api.zentail.com/v1/report`
- Auth: API key in header `AUTHORIZATION`

This returns a list of Reports (most recent reports first).

## Query parameters

- `createdTs` string
- `pageLength` integer
- `nextToken` string

## Response `200`

Success

- ReportsResponse
  - `results` Report[]
    - `reportId` integer
    - `label` string
    - `isExport` boolean: If true, this is an export. Otherwise it's an import.
    - `requestedTs` string, date-time: Timestamp when the report was requested to be run.
    - `completedTs` string, date-time: Timestamp when the report was completed.
    - `columnTypes` string[]: Array of the column headers in this report.
    - `status` 'PENDING' | 'PROCESSING' | 'CANCELED' | 'COMPLETE'
    - `totalLines` integer: Total number of lines processed successfully.
    - `linesSuccessfullyProcessed` integer
    - `filePath` string: Path to access the stored file. Use this to download an exported file when it is "COMPLETE"
    - `errorMessage` string: Returns an error message if we ran into an error processing the report.
    - `overwriteWithBlank` boolean: *For imports only:* If set to true, blank values supplied in the upload data will overwrite. NULL is equivalent to false.
    - `createNewProducts` boolean: *For imports only:* If set to true, if a SKU doesn't exist in zentail we will create one. NULL is equivalent to false.
    - `activeOnly` boolean: *For exports only:* If set to true, export will only include active products.
    - `insertOnly` boolean: *For imports only:* If set to true, report will only fill in blank data on Zentail. Any data that already exists on Zentail will not be overwritten by data in the file.
    - `includeHeader` boolean: *For exports only:* If set to true, export will include a header
    - `exportForExcel` boolean: *For exports only:* If set to true, will export as an Excel file.
    - `filter` string: *For exports only:* Use this to pass in filters to restrict the products being exported. See how to write a filter formula [here](https://help.zentail.com/import-export/how-to-write-a-filter-formula-for-import-and-exports).
    - `delimiter` string: *For exports only:* We will use this delimiter to separate the data in the export.
    - `headersOnly` boolean: *For exports only:* If true, this export will only have header rows.
    - `uploader` string: If this is null, then the report was created by the API.
  - `pagination` Pagination
    - `hasNext` boolean: Indicates if there is an additional page. This is `true` if there is another page, otherwise it is `false`.
    - `nextToken` string, uri: If `hasNext` is `true` this provides the full URL for the next page of results.

## Other responses

- `400`: Bad Request
- `403`: Permission Denied
- `404`: Not Found
- `500`: Zentail Error
- `503`: Zentail Error

---

[API](https://skmtc.dev/zentail/apis/zentail-api.md) - [All operations](https://skmtc.dev/zentail/apis/zentail-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zentail/apis/zentail-api/revisions/55e43cb43caf?raw)