> ## 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.

# List exportable datasets

> List the datasets you can export and what each one accepts.

For each dataset you get:

- `dimensions` and `measures`: the values you can send in `dimensions` and
  `metrics` when you create an export.
- `filters`: the dimensions that `startDate` and `endDate` filter on.
- `granularities`: the values you can send in `granularity`; `day_local`
  means one row per local day.



## OpenAPI

````yaml /openapi.json get /public/v1/export-service/datasets
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/datasets:
    get:
      tags:
        - Export API
      summary: List exportable datasets
      description: >-
        List the datasets you can export and what each one accepts.


        For each dataset you get:


        - `dimensions` and `measures`: the values you can send in `dimensions`
        and
          `metrics` when you create an export.
        - `filters`: the dimensions that `startDate` and `endDate` filter on.

        - `granularities`: the values you can send in `granularity`; `day_local`
          means one row per local day.
      operationId: public_list_export_datasets
      responses:
        '200':
          description: >-
            The datasets you can export, with their dimensions, metrics, filters
            and granularities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Advanced_APIs_ListExportDatasetsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Advanced_APIs_HTTPValidationError'
      security:
        - Advanced_APIs_HTTPBearer: []
components:
  schemas:
    Advanced_APIs_ListExportDatasetsResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/Advanced_APIs_ExportDatasetItem'
          type: array
          title: Results
          description: One entry per dataset.
      type: object
      required:
        - results
      title: ListExportDatasetsResponse
      description: The datasets you can export.
    Advanced_APIs_HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/Advanced_APIs_ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Advanced_APIs_ExportDatasetItem:
      properties:
        dataset:
          $ref: '#/components/schemas/Advanced_APIs_ExportDataset'
          description: The value to send as `dataset` when you create an export.
        description:
          type: string
          title: Description
          description: What the dataset contains.
          examples:
            - >-
              Advertising performance broken down by campaign, placement, and
              device, aggregated by day in the marketplace's local timezone.
        dimensions:
          items:
            $ref: '#/components/schemas/Advanced_APIs_ExportPublicDimension'
          type: array
          title: Dimensions
          description: The values you can send in `dimensions`.
        measures:
          items:
            $ref: '#/components/schemas/Advanced_APIs_ExportMetric'
          type: array
          title: Measures
          description: The values you can send in `metrics`.
        filters:
          items:
            $ref: '#/components/schemas/Advanced_APIs_ExportPublicDimension'
          type: array
          title: Filters
          description: The dimensions that `startDate` and `endDate` filter on.
        granularities:
          items:
            $ref: '#/components/schemas/Advanced_APIs_ExportGranularity'
          type: array
          title: Granularities
          description: >-
            The values you can send in `granularity`; `day_local` means one row
            per local day.
          examples:
            - - day_local
      type: object
      required:
        - dataset
        - description
        - dimensions
        - measures
        - filters
        - granularities
      title: ExportDatasetItem
      description: A dataset you can export, with the dimensions and metrics it accepts.
    Advanced_APIs_ValidationError:
      properties:
        loc:
          items:
            oneOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    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_ExportPublicDimension:
      type: string
      enum:
        - vendor_id
        - campaign_id
        - entity_type
        - entity_id
        - day_local
        - device_type
        - page_id
        - page_type
        - page_value
        - placement_page
        - auction_device
        - auction_location
        - auction_page_type
        - auction_page_id
        - auction_page_value
        - auction_search_query
        - auction_category
        - currency_code
        - external_vendor_id
        - vendor_name
        - campaign_name
        - external_campaign_id
        - status
        - campaign_type
        - ad_format
        - charge_type
        - is_active
      title: ExportPublicDimension
      description: >-
        Dimensions you can group an export by; each one becomes a column in the
        file.
    Advanced_APIs_ExportMetric:
      type: string
      enum:
        - impressions
        - clicks
        - charged_clicks
        - charged_impressions
        - charged_attributed_purchases
        - quantity
        - purchase_count
        - ad_spent_clicks
        - ad_spent_impressions
        - ad_spent_exclusive_campaign
        - ad_spent_attributed_purchases
        - ad_spend
        - total_purchase_amount
        - ctr
        - conversion_rate
        - cpc
        - cpm
        - roas
        - acos
      title: ExportMetric
      description: >-
        Metrics you can include in an export; each one becomes a column in the
        file.
    Advanced_APIs_ExportGranularity:
      type: string
      enum:
        - day_local
      title: ExportGranularity
      description: >-
        How export rows are grouped in time; `day_local` means one row per local
        day.
  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.