> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.levanta.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Reports

> List per-product reports at the product/date/link granularity within a date range [start, end].
    Filter by asins, links, or source. The difference in time between the start date and end date can be no longer than 1 year.
    Dates must be specified in ISO format with no offset (UTC), format: "yyyy-MM-ddTHH:mm:ss.SSSZ".



## OpenAPI

````yaml https://app.levanta.io/api/creator/v1/openapi.json get /reports
openapi: 3.1.0
info:
  version: 1.0.0
  title: Levanta Creator API
  description: >-
    Authorize all requests with an API key in the Authorization header as the
    second token. E.g. Authorization -> "Bearer {api_key}".
servers:
  - url: https://app.levanta.io/api/creator/v1
security: []
externalDocs:
  url: https://app.levanta.io/creator/api-docs
paths:
  /reports:
    get:
      tags:
        - Reports
      summary: List Reports
      description: >-
        List per-product reports at the product/date/link granularity within a
        date range [start, end].
            Filter by asins, links, or source. The difference in time between the start date and end date can be no longer than 1 year.
            Dates must be specified in ISO format with no offset (UTC), format: "yyyy-MM-ddTHH:mm:ss.SSSZ".
      operationId: ListReports
      parameters:
        - schema:
            type: number
            minimum: 1
            maximum: 500
            default: 100
            description: The maximum number of items to return
          required: false
          description: The maximum number of items to return
          name: limit
          in: query
        - schema:
            type: string
            maxLength: 512
            description: >-
              The cursor returned from the last request, if omitted the first
              page will be returned
          required: false
          description: >-
            The cursor returned from the last request, if omitted the first page
            will be returned
          name: cursor
          in: query
        - schema:
            type: string
            format: date-time
            description: 'Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ'
          required: true
          description: 'Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ'
          name: start
          in: query
        - schema:
            type: string
            format: date-time
            description: 'Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ'
          required: true
          description: 'Date in ISO Format without offset (UTC): YYYY-MM-DDTHH:mm:ss.SSSZ'
          name: end
          in: query
        - schema:
            type: string
            description: >-
              Comma-delimited list of ASINs representing an array. Example:
              B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]
          required: false
          description: >-
            Comma-delimited list of ASINs representing an array. Example:
            B09G9FPHY6,B09G9FPHY7 equivalent to [B09G9FPHY6,B09G9FPHY7]
          name: asins
          in: query
        - schema:
            type: string
            description: >-
              Comma-delimited list of strings representing an array. Example:
              1,2,3 equivalent to [1,2,3]
          required: false
          description: >-
            Comma-delimited list of strings representing an array. Example:
            1,2,3 equivalent to [1,2,3]
          name: link_ids
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 256
            pattern: ^[a-zA-Z0-9-_@./ ]*$
            description: >-
              An ID that identifies where the created link will be used. Allowed
              characters: [a-zA-Z0-9-_@./ ]
          required: false
          description: >-
            An ID that identifies where the created link will be used. Allowed
            characters: [a-zA-Z0-9-_@./ ]
          name: source_id
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 256
            pattern: ^[a-zA-Z0-9-_@./ ]*$
            description: >-
              An ID that identifies where the created link will be used. Allowed
              characters: [a-zA-Z0-9-_@./ ]
          required: false
          description: >-
            An ID that identifies where the created link will be used. Allowed
            characters: [a-zA-Z0-9-_@./ ]
          name: source_sub_id
          in: query
        - schema:
            type: string
            enum:
              - all
              - amazon.com
              - amazon.co.uk
              - amazon.com.mx
              - amazon.ca
              - amazon.de
              - amazon.es
              - amazon.fr
              - amazon.it
              - amazon.nl
            default: amazon.com
            description: >-
              Represents an Amazon marketplace. If "all" is specified then the
              scope is all marketplaces.
          required: false
          description: >-
            Represents an Amazon marketplace. If "all" is specified then the
            scope is all marketplaces.
          name: marketplace
          in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  reports:
                    type: array
                    items:
                      type: object
                      properties:
                        asin:
                          type: string
                          description: >-
                            Amazon Standard Identifier (ASIN) for an Amazon
                            product. Example: B09G9FPHY6
                        date:
                          type: string
                          format: date-time
                          description: >-
                            Date in ISO Format without offset (UTC):
                            YYYY-MM-DDTHH:mm:ss.SSSZ
                        marketplace:
                          type: string
                          enum:
                            - amazon.com
                            - amazon.co.uk
                            - amazon.com.mx
                            - amazon.ca
                            - amazon.de
                            - amazon.es
                            - amazon.fr
                            - amazon.it
                            - amazon.nl
                          description: Represents an Amazon marketplace.
                        currency:
                          type: string
                          enum:
                            - USD
                            - GBP
                            - CAD
                            - EUR
                            - MXN
                        commissionEarned:
                          type: number
                          description: The commission earned on the report
                        sales:
                          type: number
                        conversions:
                          type: number
                        clicks:
                          type: number
                          description: >-
                            The number of page views for the amazon product's
                            detail page
                        addToCarts:
                          type: number
                        detailPageViews:
                          type: number
                          description: >-
                            The number of page views for the amazon product's
                            detail page
                        directSales:
                          type: number
                        directConversions:
                          type: number
                        directClicks:
                          type: number
                        directAddToCarts:
                          type: number
                        directDetailPageViews:
                          type: number
                        haloSales:
                          type: number
                        haloConversions:
                          type: number
                        haloClicks:
                          type: number
                        haloAddToCarts:
                          type: number
                        haloDetailPageViews:
                          type: number
                        invoice:
                          type: object
                          properties:
                            brandId:
                              type: string
                              format: uuid
                            status:
                              type: string
                              enum:
                                - pending
                                - late
                                - paid
                              description: The status of the invoice.
                            year:
                              type: number
                              exclusiveMinimum: 2000
                              exclusiveMaximum: 3000
                            month:
                              type: number
                              minimum: 0
                              exclusiveMaximum: 13
                          required:
                            - brandId
                            - status
                            - year
                            - month
                        link:
                          type: object
                          properties:
                            id:
                              type: string
                            sourceId:
                              type: string
                              description: >-
                                An ID that identifies where the created link
                                will be used. Allowed characters:
                                [a-zA-Z0-9-_@./ ]
                            sourceSubId:
                              type: string
                              description: >-
                                An ID to further identify the link underneath
                                the source_id namespace. Allowed characters:
                                [a-zA-Z0-9-_@./ ]
                            sourceName:
                              type: string
                              description: Display name for the source within Levanta
                            url:
                              type: string
                            mobileOptimizedUrl:
                              type: string
                            active:
                              type: boolean
                              description: >-
                                Whether or not the link is active. Inactive
                                links do not earn commissions.
                            type:
                              type: string
                              enum:
                                - product
                                - storefront
                              description: >-
                                The type of the link. Product links are for
                                amazon asin pages. Storefront links are for
                                amazon storefront pages.
                            marketplace:
                              type: string
                              enum:
                                - amazon.com
                                - amazon.co.uk
                                - amazon.com.mx
                                - amazon.ca
                                - amazon.de
                                - amazon.es
                                - amazon.fr
                                - amazon.it
                                - amazon.nl
                              description: The marketplace the link is associated with
                          required:
                            - id
                            - sourceId
                            - sourceSubId
                            - sourceName
                            - url
                            - mobileOptimizedUrl
                            - active
                            - type
                            - marketplace
                        final:
                          type: boolean
                          description: When true the numbers in this report will not change
                      required:
                        - asin
                        - date
                        - marketplace
                        - currency
                        - commissionEarned
                        - sales
                        - conversions
                        - clicks
                        - addToCarts
                        - detailPageViews
                        - directSales
                        - directConversions
                        - directClicks
                        - directAddToCarts
                        - directDetailPageViews
                        - haloSales
                        - haloConversions
                        - haloClicks
                        - haloAddToCarts
                        - haloDetailPageViews
                        - invoice
                        - link
                        - final
                  cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The cursor to use for the next request, if empty there are
                      no more items to return
                required:
                  - reports
                  - cursor
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    enum:
                      - 401
                  message:
                    type: string
                    enum:
                      - Unauthorized
                required:
                  - status
                  - message
        '422':
          description: Input Validation Failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    enum:
                      - 422
                  message:
                    type: string
                    enum:
                      - Input Validation Failed
                required:
                  - status
                  - message
      security:
        - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````