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

# Read dashboard history

> Specify the link, its actual live/demo environment and a supported reporting currency.

<Note>Preview contract. Production availability remains subject to activation and release qualification. Examples are synthetic; the documentation cannot submit requests.</Note>

## Authorization

`read`; exact-link aggregate requires an unrestricted instrument policy.

## Behavior

Specify the link, its actual live/demo environment and a supported reporting currency. market is all, spot or futures; pair\_id is a reporting identity. Supply before or after, never both, as positive canonical Unix seconds. Respect reporting coverage and temporary unavailability.

## Request example

```http theme={null}
GET /v1/dashboard/history?exchange_link_id=17&environment=demo&currency=USDT
Authorization: Bearer YOUR_API_KEY_FROM_PRIVATE_STORAGE
```

All IDs and dates are illustrative. URL-encode opaque query values and supply each allowed key once. Optional filters and their types appear in the generated schema below.

## Response and errors

The generated response schema below is the wire contract. Preserve fixed-point strings, nullable fields and endpoint-specific envelopes. Inspect HTTP status and Content-Type before decoding failures; reused trading routes may return JSON or plain text. Authentication, entitlement and exact link/instrument restrictions apply in addition to endpoint validation. See [errors and recovery](/api/errors-and-limits).

Read the [related guide](/api/templates-and-history) for lifecycle, units and recovery semantics.


## OpenAPI

````yaml api/openapi.json GET /v1/dashboard/history
openapi: 3.1.0
info:
  title: Liftx integrations
  version: 1.0.0
  description: >-
    Preview contract for the Liftx API, TradingView webhook and session-owned
    integration settings. Production availability is pending activation and
    release qualification. External access requires Pro or trial entitlement and
    is unmetered within bounded resource limits. Receipt acceptance does not
    confirm execution completion. MCP is not active.
servers:
  - url: https://api.liftx.io
security: []
paths:
  /v1/dashboard/history:
    get:
      summary: Read canonical exact-link dashboard history
      description: >-
        Returns the canonical Liftx response documented below. Preserve
        fixed-point decimals and inspect HTTP status and Content-Type before
        decoding errors.
      operationId: get_v1_dashboard_history
      parameters:
        - name: exchange_link_id
          in: query
          required: true
          schema:
            type: integer
            minimum: 1
            maximum: 9007199254740991
        - name: environment
          in: query
          required: true
          schema:
            type: string
        - name: currency
          in: query
          required: true
          schema:
            type: string
        - name: market
          in: query
          required: false
          schema:
            type: string
        - name: before
          in: query
          required: false
          schema:
            type: integer
            format: int64
        - name: after
          in: query
          required: false
          schema:
            type: integer
            format: int64
        - name: pair_id
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/History'
              examples:
                synthetic:
                  summary: Synthetic complete zero-P&L sample
                  description: >-
                    Synthetic documentation data, not an account snapshot,
                    executable market configuration or production-availability
                    assertion. IDs, quantities, prices, times and values are
                    illustrative.
                  value:
                    revision: '1893456000000000000'
                    scope:
                      exchange_link_id: 17
                      environment: demo
                      currency: USDT
                    as_of: 1893456000
                    points:
                      - rate_at: 1893456000
                        time: 1893456000
                        value:
                          atomic: '0'
                          scale: 0
                        complete: true
                        resolution: 1
                    before: 0
                    after: 0
                    selection:
                      market: all
                      pair_id: ''
        default:
          description: >-
            Integration errors use Error; existing trading handlers retain their
            own JSON or text/plain error codec. Inspect status and content type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            text/plain:
              schema:
                type: string
      security:
        - ApiKey: []
components:
  schemas:
    History:
      type: object
      properties:
        revision:
          type: string
        scope:
          $ref: '#/components/schemas/Scope'
        as_of:
          type: integer
          format: int64
        points:
          type: array
          items:
            $ref: '#/components/schemas/HistoryPoint'
        before:
          type: integer
          format: int64
        after:
          type: integer
          format: int64
        selection:
          $ref: '#/components/schemas/PNLSelection'
      required:
        - revision
        - scope
        - as_of
        - points
        - before
        - after
        - selection
      additionalProperties: false
    Error:
      type: object
      properties:
        success:
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          additionalProperties: false
      required:
        - success
        - error
      additionalProperties: false
    Scope:
      type: object
      properties:
        exchange_link_id:
          type: integer
          format: int64
        environment:
          type: string
        currency:
          type: string
      required:
        - exchange_link_id
        - environment
        - currency
      additionalProperties: false
    HistoryPoint:
      type: object
      properties:
        rate_at:
          type: integer
          format: int64
        time:
          type: integer
          format: int64
        value:
          anyOf:
            - $ref: '#/components/schemas/Decimal'
            - type: 'null'
        complete:
          type: boolean
        resolution:
          type: integer
          format: int64
      required:
        - rate_at
        - time
        - value
        - complete
        - resolution
      additionalProperties: false
    PNLSelection:
      type: object
      properties:
        market:
          type: string
        pair_id:
          type: string
      required:
        - market
        - pair_id
      additionalProperties: false
    Decimal:
      type: object
      properties:
        atomic:
          type: string
        scale:
          type: integer
          format: int64
      required:
        - atomic
        - scale
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: lx_api_<credential UUID>.<256-bit secret>

````

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