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

# Get dashboard card data

> Requires dashboard.read. Returns the data of every dashboard card except achievement and geo: profit summary, sales over time against the previous period, accesses, conversion funnel, payment methods and statuses, platform and traffic-source shares, device/browser/OS/UTM/referrer shares, top pages, link and domain accesses, revenue by UTM, and accesses/sales by hour and weekday. Shares are fractions (0-1). startDate and endDate are calendar days (YYYY-MM-DD, inclusive) in the team timezone. funnelSteps is an optional comma-separated list of funnel step ids.



## OpenAPI

````yaml https://api.trackup.me/openapi.json get /v1/projects/{id}/analytics/dashboard
openapi: 3.1.0
info:
  title: Trackup API
  description: >-
    API-key-accessible Trackup operations. Send your key in the `X-Api-Key`
    header.


    Keys belong to a team. `X-Team-Id` is not required; if supplied, it must
    match that team.


    Each operation lists its required key permission. The key creator must
    remain a team member and normally hold that permission. The ingest-only
    permissions `visitor.create`, `conversion.create`, and `request.create` do
    not need to be held by the creator.


    Project access and selection are described per operation. Session-only
    account, administration and OAuth operations are not part of this reference.


    The same operations are available as MCP tools at `/mcp` (Streamable HTTP).
    Authenticate with `X-Api-Key` or connect through OAuth, which issues an API
    key on consent.


    Schema validation errors return HTTP 422 with an `errors` object. Other
    errors generally contain `error` and `message`; operation-specific responses
    describe exceptions.
  version: 1.0.0
servers:
  - url: /
    description: Current API environment
security:
  - ApiKey: []
paths:
  /v1/projects/{id}/analytics/dashboard:
    get:
      tags:
        - Dashboards
      summary: Get dashboard card data
      description: >-
        Requires dashboard.read. Returns the data of every dashboard card except
        achievement and geo: profit summary, sales over time against the
        previous period, accesses, conversion funnel, payment methods and
        statuses, platform and traffic-source shares,
        device/browser/OS/UTM/referrer shares, top pages, link and domain
        accesses, revenue by UTM, and accesses/sales by hour and weekday. Shares
        are fractions (0-1). startDate and endDate are calendar days
        (YYYY-MM-DD, inclusive) in the team timezone. funnelSteps is an optional
        comma-separated list of funnel step ids.
      operationId: getProjectDashboardAnalytics
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
        - in: query
          name: startDate
          schema:
            type: string
            format: date
          required: true
        - in: query
          name: endDate
          schema:
            type: string
            format: date
          required: true
        - in: query
          name: granularity
          schema:
            type: string
            enum:
              - hour
              - day
        - in: query
          name: funnelSteps
          schema:
            type: string
      responses:
        '200':
          description: Dashboard card data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardAnalytics'
        '401':
          description: The X-Api-Key header is missing or the API key is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            The key is expired, revoked, lacks permission, or its creator no
            longer has the required team access. A conflicting X-Team-Id is also
            rejected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            The requested resource was not found or is outside the permitted
            scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: >-
            Invalid input. Each field path maps to its first validation message;
            _form identifies an object-level error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '500':
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    DashboardAnalytics:
      type: object
      properties:
        currency:
          type: string
        granularity:
          type: string
          enum:
            - hour
            - day
        summary:
          type: object
          properties:
            profit:
              type: number
            ordersCount:
              type: number
            profitChangePercent:
              type: number
            profitChangeAmount:
              type: number
            roas:
              type: number
            revenue:
              type: number
            revenueChangePercent:
              type: number
            expenses:
              type: number
            expensesChangePercent:
              type: number
            trend:
              type: string
              enum:
                - up
                - down
          required:
            - profit
            - ordersCount
            - profitChangePercent
            - profitChangeAmount
            - roas
            - revenue
            - revenueChangePercent
            - expenses
            - expensesChangePercent
            - trend
        sales:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              current:
                type: number
              previous:
                type: number
            required:
              - date
              - current
              - previous
        accesses:
          type: object
          properties:
            total:
              type: object
              properties:
                value:
                  type: number
                changePercent:
                  type: number
                series:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      value:
                        type: number
                    required:
                      - date
                      - value
              required:
                - value
                - changePercent
                - series
            unique:
              type: object
              properties:
                value:
                  type: number
                changePercent:
                  type: number
                series:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      value:
                        type: number
                    required:
                      - date
                      - value
              required:
                - value
                - changePercent
                - series
            real:
              type: object
              properties:
                value:
                  type: number
                changePercent:
                  type: number
                series:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      value:
                        type: number
                    required:
                      - date
                      - value
              required:
                - value
                - changePercent
                - series
            bots:
              type: object
              properties:
                value:
                  type: number
                changePercent:
                  type: number
                series:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      value:
                        type: number
                    required:
                      - date
                      - value
              required:
                - value
                - changePercent
                - series
          required:
            - total
            - unique
            - real
            - bots
        funnel:
          type: object
          properties:
            steps:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  count:
                    type: number
                  metric:
                    type:
                      - string
                      - 'null'
                    enum:
                      - cpm
                      - cpc
                      - ctr
                      - connect_rate
                      - cpatc
                      - cpic
                      - cpa
                      - null
                  metricValue:
                    type: number
                required:
                  - id
                  - count
                  - metric
                  - metricValue
          required:
            - steps
        paymentMethods:
          type: array
          items:
            type: object
            properties:
              method:
                type: string
              amount:
                type: number
            required:
              - method
              - amount
        paymentStatuses:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                enum:
                  - pending
                  - approved
                  - refund
                  - chargeback
              count:
                type: number
              amount:
                type: number
              changePercent:
                type: number
            required:
              - id
              - count
              - amount
              - changePercent
        platforms:
          type: array
          items:
            type: object
            properties:
              platform:
                type: string
              share:
                type: number
            required:
              - platform
              - share
        trafficSources:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
              share:
                type: number
            required:
              - source
              - share
        clients:
          type: object
          properties:
            devices:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
            browsers:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
            operatingSystems:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
            utm:
              type: object
              properties:
                source:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      share:
                        type: number
                    required:
                      - key
                      - share
                medium:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      share:
                        type: number
                    required:
                      - key
                      - share
                campaign:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      share:
                        type: number
                    required:
                      - key
                      - share
                term:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      share:
                        type: number
                    required:
                      - key
                      - share
                content:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      share:
                        type: number
                    required:
                      - key
                      - share
              required:
                - source
                - medium
                - campaign
                - term
                - content
            referrers:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
          required:
            - devices
            - browsers
            - operatingSystems
            - utm
            - referrers
        topPages:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              share:
                type: number
            required:
              - key
              - share
        destinations:
          type: object
          properties:
            links:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
            domains:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
          required:
            - links
            - domains
        revenueUtm:
          type: object
          properties:
            source:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
            medium:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
            campaign:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
            term:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
            content:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  share:
                    type: number
                required:
                  - key
                  - share
          required:
            - source
            - medium
            - campaign
            - term
            - content
        timeDistribution:
          type: object
          properties:
            hour:
              type: array
              items:
                type: object
                properties:
                  bucket:
                    type: number
                  accesses:
                    type: number
                  sales:
                    type: number
                  revenue:
                    type: number
                required:
                  - bucket
                  - accesses
                  - sales
                  - revenue
            weekday:
              type: array
              items:
                type: object
                properties:
                  bucket:
                    type: number
                  accesses:
                    type: number
                  sales:
                    type: number
                  revenue:
                    type: number
                required:
                  - bucket
                  - accesses
                  - sales
                  - revenue
          required:
            - hour
            - weekday
      required:
        - currency
        - granularity
        - summary
        - sales
        - accesses
        - funnel
        - paymentMethods
        - paymentStatuses
        - platforms
        - trafficSources
        - clients
        - topPages
        - destinations
        - revenueUtm
        - timeDistribution
      example:
        currency: BRL
        granularity: day
        summary:
          profit: 1200
          ordersCount: 30
          profitChangePercent: 8
          profitChangeAmount: 90
          roas: 3.2
          revenue: 1750
          revenueChangePercent: 10
          expenses: 550
          expensesChangePercent: 4
          trend: up
        sales:
          - date: '2026-10-01'
            current: 350
            previous: 300
        accesses:
          total:
            value: 120
            changePercent: 12.5
            series:
              - date: '2026-10-01'
                value: 120
          unique:
            value: 120
            changePercent: 12.5
            series:
              - date: '2026-10-01'
                value: 120
          real:
            value: 120
            changePercent: 12.5
            series:
              - date: '2026-10-01'
                value: 120
          bots:
            value: 4
            changePercent: 12.5
            series:
              - date: '2026-10-01'
                value: 120
        funnel:
          steps:
            - id: page_view
              count: 900
              metric: connect_rate
              metricValue: 0.75
            - id: purchase
              count: 30
              metric: cpa
              metricValue: 18.3
        paymentMethods:
          - method: pix
            amount: 1100
        paymentStatuses:
          - id: approved
            count: 30
            amount: 1750
            changePercent: 10
        platforms:
          - platform: upag
            share: 1
        trafficSources:
          - source: facebook
            share: 0.7
        clients:
          devices:
            - key: mobile
              share: 0.8
          browsers:
            - key: chrome
              share: 0.6
          operatingSystems:
            - key: android
              share: 0.55
          utm:
            source:
              - key: facebook
                share: 0.7
            medium:
              - key: cpc
                share: 1
            campaign:
              - key: ebook
                share: 1
            term: []
            content: []
          referrers:
            - key: instagram.com
              share: 0.4
        topPages:
          - key: /ebook
            share: 0.9
        destinations:
          links:
            - key: Ebook
              share: 1
          domains:
            - key: example.com
              share: 1
        revenueUtm:
          source:
            - key: facebook
              share: 0.7
          medium:
            - key: cpc
              share: 1
          campaign:
            - key: ebook
              share: 1
          term: []
          content: []
        timeDistribution:
          hour:
            - bucket: 20
              accesses: 90
              sales: 4
              revenue: 230
          weekday:
            - bucket: 1
              accesses: 140
              sales: 6
              revenue: 350
    ApiError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      additionalProperties: true
    ValidationError:
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: string
      required:
        - errors
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key

````

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