> ## Documentation Index > Fetch the complete documentation index at: https://docs.topsort.com/llms.txt > Use this file to discover all available pages before exploring further. # Get an export > Check an export and download it once it is ready. Check at most once a minute. A completed export includes a download link valid for 1 hour; check again for a new one. If no rows matched, the export completes without a link and `message` says so. ## OpenAPI ````yaml /openapi.json get /public/v1/export-service/exports/{export_id} openapi: 3.1.0 info: title: Topsort Endpoints v2 API Reference description: > In order for a storefront to be able to run auctions in Topsort and report auction-related events back to Topsort, both the `/v2/auctions` and `/v2/events` endpoints must be integrated. Below are the endpoint and model definitions for each. contact: email: wicha@topsort.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html x-logo: url: https://assets.topsort.com/Topsort_logo_icon_dark.svg backgroundColor: '#fff' altText: Topsort version: 2.0.0 servers: - url: https://api.topsort.com description: Base API URL security: [] tags: - name: Auctions description: >- An auction determines which products should be promoted based on the vendors' bids. - name: Events description: >- Events are sent to Topsort as part of the attribution and reporting journey. - name: Toptimize description: > An out-of-the-box solution for prediction, ranking, retrieval, and other elements of ad selection. - name: Toppie API description: Toppie management API. - name: Campaign API description: Full-featured campaign management API for banners and sponsored listings. - name: Catalog API description: Products catalog management API. - name: Billing API description: Marketplace and Vendor Billing management API. - name: Reporting API description: Marketplace, Vendor, Campaign, and product reporting API. - name: Invitation API description: Vendor invitations management API. - name: User API description: User management API. - name: Webhooks API description: Webhooks API that allows event-driven automation. - name: Assets API description: Assets management API. - name: Segments Service description: Segments Service. - name: Forecasting Service description: Toptimize Forecasting Service. - name: Offsite Ads API description: Offsite Ads API that allows to manage offsite ads campaigns. - name: Media API description: Ad configuration API. - name: Placement API description: Placement management API for sponsored brand slots. - name: Export API description: Request an asynchronous Parquet export of your performance data. paths: /public/v1/export-service/exports/{export_id}: get: tags: - Export API summary: Get an export description: |- Check an export and download it once it is ready. Check at most once a minute. A completed export includes a download link valid for 1 hour; check again for a new one. If no rows matched, the export completes without a link and `message` says so. operationId: public_get_export parameters: - name: export_id in: path required: true schema: type: string format: uuid description: The `exportId` returned when you created the export. title: Export Id description: The `exportId` returned when you created the export. responses: '200': description: >- Your export. A completed one includes a download link, or `message` when it has no rows. content: application/json: schema: $ref: '#/components/schemas/Advanced_APIs_GetExportResponse' '404': description: No export with this id exists. '422': description: >- The export id is not a UUID (`validation_error`). `details` names the field to fix. content: application/json: schema: $ref: '#/components/schemas/Advanced_APIs_ExportServiceErrorResponse' security: - Advanced_APIs_HTTPBearer: [] components: schemas: Advanced_APIs_GetExportResponse: properties: exportId: type: string format: uuid title: Exportid description: ID of your export. examples: - 218ad339-00cd-4e11-aeaa-8d96694908a0 status: $ref: '#/components/schemas/Advanced_APIs_ExportStatus' description: Current status of your export. examples: - completed dataset: $ref: '#/components/schemas/Advanced_APIs_ExportDataset' description: The dataset being exported. examples: - monitoring_metrics createdAt: type: string format: date-time title: Createdat description: When you requested the export. examples: - '2026-09-08T14:03:12Z' downloadUrl: title: Downloadurl description: >- Link to download the Parquet file, present only when `status` is `completed` and the export has data. It is valid for 1 hour; check the export again to get a new link. examples: - >- https://downloads.example.com/exports/218ad339-00cd-4e11-aeaa-8d96694908a0.parquet?expires=3600&signature=... oneOf: - type: string - type: 'null' downloadExpiresAt: title: Downloadexpiresat description: When `downloadUrl` stops working. examples: - '2026-09-08T15:21:40Z' oneOf: - type: string format: date-time - type: 'null' error: title: Error description: >- Why the export failed, present only when `status` is `failed`. One of `An unexpected error occurred.`, `The export result did not match the expected schema` or `Export exceeded the processing time limit`. Request a new export to try again. examples: - Export exceeded the processing time limit oneOf: - type: string - type: 'null' message: title: Message description: >- Present only when `status` is `completed` but no rows matched your request, so there is no file to download: `No data was found for the requested date range.` examples: - No data was found for the requested date range. oneOf: - type: string - type: 'null' type: object required: - exportId - status - dataset - createdAt title: GetExportResponse description: >- Your export. A completed one includes a download link, or `message` when it has no rows. Advanced_APIs_ExportServiceErrorResponse: properties: error: $ref: '#/components/schemas/Advanced_APIs_ExportServiceError' description: 'What went wrong: a stable code, a message and its context.' type: object required: - error title: ExportServiceErrorResponse description: Error response. Advanced_APIs_ExportStatus: type: string enum: - pending - running - completed - failed title: ExportStatus description: 'Export status: `pending`, then `running`, then `completed` or `failed`.' Advanced_APIs_ExportDataset: type: string enum: - monitoring_metrics title: ExportDataset description: >- Datasets you can export. The datasets endpoint lists what each one accepts. Advanced_APIs_ExportServiceError: properties: code: type: string title: Code description: >- Stable error code to handle in your integration (e.g. `validation_error`, `daily_request_limit_exceeded`). examples: - internal_error message: type: string title: Message description: Human-readable explanation of the error. examples: - An unexpected error occurred. details: items: additionalProperties: true type: object type: array title: Details description: >- More context about the error, empty when there is none. `validation_error` lists each invalid input with its `type`, its location (`loc`), a message (`msg`) and the value you sent (`input`). Duplicate and date errors name the `field` (and the repeated `members`). `daily_request_limit_exceeded` includes `limit`, `used`, `resetsAt` and `retryAfterSeconds`. `date_range_too_large` includes `days` and `maxDays`. `date_range_too_old` includes `earliestDate` and `maxDaysBack`. examples: - [] type: object required: - code - message title: ExportServiceError description: What went wrong with your request. securitySchemes: Advanced_APIs_HTTPBearer: type: http description: >- A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.