> ## 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 project analytics

> Requires analytics.read. startDate and endDate are calendar days (YYYY-MM-DD, inclusive) in the team timezone; endDate must not be before startDate. Granularity defaults to hour when endDate is at most 3 days after startDate, otherwise day.



## OpenAPI

````yaml https://api.trackup.me/openapi.json get /v1/projects/{id}/analytics/overview
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/overview:
    get:
      tags:
        - Analytics
      summary: Get project analytics
      description: >-
        Requires analytics.read. startDate and endDate are calendar days
        (YYYY-MM-DD, inclusive) in the team timezone; endDate must not be before
        startDate. Granularity defaults to hour when endDate is at most 3 days
        after startDate, otherwise day.
      operationId: getProjectAnalyticsOverview
      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
      responses:
        '200':
          description: Project totals and time series.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectAnalytics'
        '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:
    ProjectAnalytics:
      type: object
      properties:
        granularity:
          type: string
          enum:
            - hour
            - day
        totalRequests:
          type: number
        uniqueVisitors:
          type: number
        totalConversions:
          type: number
        totalRevenue:
          type: number
        averageOrderValue:
          type: number
        requestsOverTime:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              requests:
                type: number
              visitors:
                type: number
            required:
              - date
              - requests
              - visitors
        revenueOverTime:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              revenue:
                type: number
              conversions:
                type: number
            required:
              - date
              - revenue
              - conversions
        topCountries:
          type: array
          items:
            type: object
            properties:
              country:
                type: string
              count:
                type: number
            required:
              - country
              - count
        trafficSources:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
              count:
                type: number
            required:
              - source
              - count
        revenueByNetwork:
          type: array
          items:
            type: object
            properties:
              network:
                type: string
              revenue:
                type: number
              conversions:
                type: number
            required:
              - network
              - revenue
              - conversions
        revenueByTrafficSource:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
              revenue:
                type: number
              conversions:
                type: number
            required:
              - source
              - revenue
              - conversions
      required:
        - granularity
        - totalRequests
        - uniqueVisitors
        - totalConversions
        - totalRevenue
        - averageOrderValue
        - requestsOverTime
        - revenueOverTime
        - topCountries
        - trafficSources
        - revenueByNetwork
        - revenueByTrafficSource
      example:
        granularity: hour
        totalRequests: 3
        uniqueVisitors: 2
        totalConversions: 1
        totalRevenue: 49.9
        averageOrderValue: 49.9
        requestsOverTime:
          - date: '2026-06-01 12:00:00.000'
            requests: 3
            visitors: 2
        revenueOverTime:
          - date: '2026-06-01 12:00:00.000'
            revenue: 49.9
            conversions: 1
        topCountries:
          - country: BR
            count: 3
        trafficSources:
          - source: newsletter
            count: 3
        revenueByNetwork:
          - network: api
            revenue: 49.9
            conversions: 1
        revenueByTrafficSource:
          - source: newsletter
            revenue: 49.9
            conversions: 1
    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.