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

# Get a saved report's figures

> The figures the report's tile shows: a trend's buckets per series, or a list's rows, largest first, as the breakdown its dimension's card reads answers them. The report's own `period` applies unless the call passes one, and a report without one reads 7d. `date`, `from` and `to` refine a `period` the call passes, so one sent without it is a 400. A list's rows carry their revenue whatever the report's `showRevenue`. A list by property answers its most common values on one page. Walk it by passing `nextCursor` as `cursor`; the last page answers `nextCursor: null`. Reuse a cursor only with the same parameters.



## OpenAPI

````yaml https://api.highseat.com/v1/openapi.json get /sites/{site}/reports/{id}/results
openapi: 3.1.1
info:
  title: Highseat Stats API
  version: 1.0.0
  description: >-
    The same figures the dashboard shows, and the changes an admin makes there.
    A read key answers every GET route; a write key also answers the routes that
    change data.


    Authentication, write keys, idempotency, limits and the shape of every
    response: https://highseat.com/docs/api.
  license:
    name: Proprietary
servers:
  - url: https://api.highseat.com/v1
security:
  - bearerAuth: []
paths:
  /sites/{site}/reports/{id}/results:
    get:
      tags:
        - Reports
      summary: Get a saved report's figures
      description: >-
        The figures the report's tile shows: a trend's buckets per series, or a
        list's rows, largest first, as the breakdown its dimension's card reads
        answers them. The report's own `period` applies unless the call passes
        one, and a report without one reads 7d. `date`, `from` and `to` refine a
        `period` the call passes, so one sent without it is a 400. A list's rows
        carry their revenue whatever the report's `showRevenue`. A list by
        property answers its most common values on one page. Walk it by passing
        `nextCursor` as `cursor`; the last page answers `nextCursor: null`.
        Reuse a cursor only with the same parameters.
      operationId: getReportResults
      parameters:
        - name: site
          in: path
          required: true
          schema:
            type: string
            description: 'The site: its domain as registered (example.com), or its site id.'
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: The report's id, from the reports list.
        - name: period
          in: query
          schema:
            anyOf:
              - enum:
                  - day
                  - week
                  - month
                  - year
                  - all
                  - custom
                type: string
              - type: string
                pattern: ^([1-9]\d{0,3})(mo|m|h|d|w)$
            description: >-
              The range, in the grammar the reports take. Absent: the report's
              own period.
          allowEmptyValue: true
          allowReserved: true
        - name: date
          in: query
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            description: Which day/week/month/year a unit period refers to, YYYY-MM-DD.
          allowEmptyValue: true
          allowReserved: true
        - name: from
          in: query
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            description: First day of a custom range, YYYY-MM-DD, inclusive.
          allowEmptyValue: true
          allowReserved: true
        - name: to
          in: query
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            description: Last day of a custom range, YYYY-MM-DD, inclusive.
          allowEmptyValue: true
          allowReserved: true
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 20
            description: A list's page size, 1–500, default 20.
          allowEmptyValue: true
          allowReserved: true
        - name: cursor
          in: query
          schema:
            type: string
            minLength: 1
            maxLength: 8192
            description: >-
              Opaque cursor from the previous page's `nextCursor`. Omit for the
              first page (largest rows). Reuse it only with the same site,
              range, filters and tab/dimension. The last page answers
              `nextCursor: null`.
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                      - type: object
                        properties:
                          type:
                            const: trend
                          granularity:
                            enum:
                              - minute
                              - hour
                              - day
                              - week
                              - month
                            type: string
                            description: The bucket size.
                          series:
                            type: array
                            items:
                              type: object
                              properties:
                                label:
                                  type: string
                                  description: >-
                                    The series' label; empty when its filters
                                    name it.
                                points:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      date:
                                        type: string
                                        description: >-
                                          The bucket's start, in the site's
                                          timezone.
                                      value:
                                        type: number
                                        description: >-
                                          The metric in the bucket: a count, a
                                          percent, seconds, or minor units of the
                                          site's currency for revenue.
                                    required:
                                      - date
                                      - value
                              required:
                                - label
                                - points
                        required:
                          - type
                          - granularity
                          - series
                      - type: object
                        properties:
                          type:
                            const: list
                          source:
                            const: pages
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                path:
                                  type: string
                                  description: >-
                                    The page path, or the hostname on the
                                    hostnames tab.
                                visitors:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                  description: Distinct visitors.
                                count:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                  description: >-
                                    Pageviews (top, hostnames), entrances
                                    (entry), exits (exit) or hits (not_found).
                                exitRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Exit tab only: exits per
                                    pageview.
                                avgDuration:
                                  type: number
                                  description: >-
                                    Seconds. Top tab only: engaged time per
                                    view.
                                linkedFrom:
                                  type: string
                                  description: >-
                                    not_found tab only: the page that most often
                                    linked here, or an empty string.
                                conversionRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Visitors of the row that
                                    converted; 100 without a goal filter.
                                revenue:
                                  type: number
                                  description: >-
                                    Integer, minor units of the site's reporting
                                    currency (cents for USD).
                                orders:
                                  type: number
                                  description: >-
                                    Orders credited to the row by the
                                    attribution weights, to two decimals.
                              required:
                                - path
                                - visitors
                                - count
                                - conversionRate
                                - revenue
                                - orders
                        required:
                          - type
                          - source
                          - rows
                      - type: object
                        properties:
                          type:
                            const: list
                          source:
                            const: sources
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: >-
                                    The referrer source. An empty string is
                                    direct traffic: visits with no referrer, or
                                    with a page of the site itself as the
                                    referrer. The channels tab names that row
                                    Direct.
                                visitors:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                  description: Distinct visitors.
                                conversionRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Visitors of the row that
                                    converted; 100 without a goal filter.
                                bounceRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Sessions that bounced, to
                                    one decimal.
                                avgDuration:
                                  type: number
                                  description: >-
                                    Seconds. Engaged time per session, to one
                                    decimal.
                                revenue:
                                  type: number
                                  description: >-
                                    Integer, minor units of the site's reporting
                                    currency (cents for USD).
                                orders:
                                  type: number
                                  description: >-
                                    Orders credited to the row by the
                                    attribution weights, to two decimals.
                                domain:
                                  type: string
                                  description: >-
                                    A host for the source's favicon, or an empty
                                    string. On the direct row it is often the
                                    site's own host.
                                pageviews:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                              required:
                                - name
                                - visitors
                                - conversionRate
                                - bounceRate
                                - avgDuration
                                - revenue
                                - orders
                                - domain
                                - pageviews
                        required:
                          - type
                          - source
                          - rows
                      - type: object
                        properties:
                          type:
                            const: list
                          source:
                            const: locations
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: >-
                                    A country code, an ISO 3166-2 region code,
                                    or a city name. An empty string is a place
                                    that could not be recognised.
                                visitors:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                  description: Distinct visitors.
                                conversionRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Visitors of the row that
                                    converted; 100 without a goal filter.
                                bounceRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Sessions that bounced, to
                                    one decimal.
                                avgDuration:
                                  type: number
                                  description: >-
                                    Seconds. Engaged time per session, to one
                                    decimal.
                                revenue:
                                  type: number
                                  description: >-
                                    Integer, minor units of the site's reporting
                                    currency (cents for USD).
                                orders:
                                  type: number
                                  description: >-
                                    Orders credited to the row by the
                                    attribution weights, to two decimals.
                                countryCode:
                                  type: string
                                  description: The row's ISO 3166-1 country code.
                              required:
                                - name
                                - visitors
                                - conversionRate
                                - bounceRate
                                - avgDuration
                                - revenue
                                - orders
                                - countryCode
                        required:
                          - type
                          - source
                          - rows
                      - type: object
                        properties:
                          type:
                            const: list
                          source:
                            const: devices
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: >-
                                    The browser, operating system or device
                                    type. An empty string is one that could not
                                    be recognised.
                                visitors:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                  description: Distinct visitors.
                                conversionRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Visitors of the row that
                                    converted; 100 without a goal filter.
                                bounceRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Sessions that bounced, to
                                    one decimal.
                                avgDuration:
                                  type: number
                                  description: >-
                                    Seconds. Engaged time per session, to one
                                    decimal.
                                revenue:
                                  type: number
                                  description: >-
                                    Integer, minor units of the site's reporting
                                    currency (cents for USD).
                                orders:
                                  type: number
                                  description: >-
                                    Orders credited to the row by the
                                    attribution weights, to two decimals.
                              required:
                                - name
                                - visitors
                                - conversionRate
                                - bounceRate
                                - avgDuration
                                - revenue
                                - orders
                        required:
                          - type
                          - source
                          - rows
                      - type: object
                        properties:
                          type:
                            const: list
                          source:
                            const: campaigns
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                visitors:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                  description: Distinct visitors.
                                conversionRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Visitors of the row that
                                    converted; 100 without a goal filter.
                                bounceRate:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Sessions that bounced, to
                                    one decimal.
                                avgDuration:
                                  type: number
                                  description: >-
                                    Seconds. Engaged time per session, to one
                                    decimal.
                                revenue:
                                  type: number
                                  description: >-
                                    Integer, minor units of the site's reporting
                                    currency (cents for USD).
                                orders:
                                  type: number
                                  description: >-
                                    Orders credited to the row by the
                                    attribution weights, to two decimals.
                                pageviews:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                              required:
                                - name
                                - visitors
                                - conversionRate
                                - bounceRate
                                - avgDuration
                                - revenue
                                - orders
                                - pageviews
                        required:
                          - type
                          - source
                          - rows
                      - type: object
                        properties:
                          type:
                            const: list
                          source:
                            const: events
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                count:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                visitors:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                  description: Distinct visitors.
                                share:
                                  type: number
                                  description: >-
                                    Percent, 0 to 100. Visitors in the range who
                                    fired the event.
                                revenue:
                                  type: number
                                  description: >-
                                    Integer, minor units of the site's reporting
                                    currency (cents for USD). The money the
                                    event itself carried.
                              required:
                                - name
                                - count
                                - visitors
                                - share
                                - revenue
                        required:
                          - type
                          - source
                          - rows
                      - type: object
                        properties:
                          type:
                            const: list
                          source:
                            const: properties
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                value:
                                  type: string
                                count:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                visitors:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                  description: Distinct visitors.
                              required:
                                - value
                                - count
                                - visitors
                        required:
                          - type
                          - source
                          - rows
                  nextCursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Pass as `cursor` for the next page. Null on the last page.
                  meta:
                    type: object
                    properties:
                      timezone:
                        type: string
                        description: >-
                          The site's timezone, which every day boundary falls
                          in.
                      currency:
                        type: string
                        description: ISO 4217 code of every amount in the response.
                      range:
                        anyOf:
                          - type: object
                            properties:
                              from:
                                type: string
                                description: ISO 8601, inclusive.
                              to:
                                type: string
                                description: ISO 8601, exclusive.
                            required:
                              - from
                              - to
                          - type: 'null'
                        description: The instants the period resolved to.
                      compare:
                        anyOf:
                          - type: object
                            properties:
                              from:
                                type: string
                                description: ISO 8601, inclusive.
                              to:
                                type: string
                                description: ISO 8601, exclusive.
                            required:
                              - from
                              - to
                          - type: 'null'
                        description: The comparison range, when one was asked for.
                    required:
                      - timezone
                      - currency
                      - range
                      - compare
                required:
                  - data
                  - nextCursor
                  - meta
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
        '503':
          $ref: '#/components/responses/Error503'
components:
  headers:
    RateLimit-Limit:
      description: Calls the key may make in the window.
      schema:
        type: integer
    RateLimit-Remaining:
      description: Calls left in the current window.
      schema:
        type: integer
    RateLimit-Reset:
      description: Seconds until the window reopens.
      schema:
        type: integer
    RateLimit-Policy:
      description: >-
        The quota and window, as the IETF draft writes it:
        "hourly";q=600;w=3600.
      schema:
        type: string
    RateLimit:
      description: >-
        The remaining budget, as the IETF draft writes it:
        "hourly";r=599;t=3540.
      schema:
        type: string
    Retry-After:
      description: Seconds to wait before the next call.
      schema:
        type: integer
  responses:
    Error400:
      description: 'The request is malformed: BAD_REQUEST, INVALID_FILTER or INVALID_CURSOR.'
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error401:
      description: 'No API key, or one that is not valid: UNAUTHORIZED.'
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: 'The workspace''s reports are closed until it pays: FORBIDDEN.'
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error404:
      description: 'The site, the row the path names or the route does not exist: NOT_FOUND.'
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error422:
      description: 'The report ran into the time cap; try a shorter range: QUERY_TIMEOUT.'
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: >-
        The key has used its hourly budget (RATE_LIMITED), or its workspace
        already runs as many calls at once as it may
        (TOO_MANY_CONCURRENT_REQUESTS).
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error503:
      description: 'The server is busy; retry in a moment: SERVICE_UNAVAILABLE.'
      headers:
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Stable and machine-readable: BAD_REQUEST, INVALID_FILTER,
                INVALID_CURSOR, UNAUTHORIZED, FORBIDDEN, KEY_READ_ONLY,
                NOT_FOUND, METHOD_NOT_ALLOWED, CONFLICT, IDEMPOTENCY_KEY_IN_USE,
                PAYLOAD_TOO_LARGE, IDEMPOTENCY_KEY_REUSED, QUERY_TIMEOUT,
                RATE_LIMITED, TOO_MANY_CONCURRENT_REQUESTS, SERVICE_UNAVAILABLE
                or INTERNAL_SERVER_ERROR. A write may answer a code of its own:
                a conflict (GOAL_EXISTS, DOMAIN_TAKEN, SECRET_EXISTS) or a limit
                (GOAL_LIMIT_REACHED, FUNNEL_LIMIT_REACHED). Codes are added,
                never renamed.
            message:
              type: string
              description: What went wrong, written for a person.
            id:
              type: string
              description: >-
                On a conflict, the existing row's id, so a client can update it
                instead.
            issues:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: array
                    items:
                      anyOf:
                        - type: string
                        - type: number
                    description: >-
                      The parameter at fault, e.g. ['filter', 1] for the second
                      filter.
                  message:
                    type: string
                required:
                  - path
                  - message
              description: One entry per invalid parameter.
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.