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

# Get endpoint usage history for authorized partner tenants.

> This endpoint returns endpoint usage history, bucketed by day or month, over a bounded date
range for the authorized partner's tenant scope.

**Notes:**
- `tenant_ids` (optional, comma-separated) restricts results to specific tenants.
- `from` / `to` (required, `yyyy-MM-dd`) bound the usage date range. `from` must not be
  later than `to`.
- `grain` (optional, one of `day`, `month`; default `day`) controls the bucketing interval.


Required headers:

- `Authorization: Bearer {token}` (requires the `pulse.read` scope)



## OpenAPI

````yaml /api/partner-api/reporting.json get /pulse/v1/partner/usage
openapi: 3.1.1
info:
  title: 'Cyrisma New Partner API: Reporting'
  version: v1
servers:
  - url: https://{instance}.cyrisma.com/app
    description: The partner's CYRISMA instance host.
    variables:
      instance:
        default: ccnnnnnn
        description: The instance label of the tenant host issued to the partner.
security:
  - bearerAuth:
      - pulse.read
tags:
  - name: Reporting
paths:
  /pulse/v1/partner/usage:
    get:
      tags:
        - Reporting
      summary: Get endpoint usage history for authorized partner tenants.
      description: >-
        This endpoint returns endpoint usage history, bucketed by day or month,
        over a bounded date

        range for the authorized partner's tenant scope.


        **Notes:**

        - `tenant_ids` (optional, comma-separated) restricts results to specific
        tenants.

        - `from` / `to` (required, `yyyy-MM-dd`) bound the usage date range.
        `from` must not be
          later than `to`.
        - `grain` (optional, one of `day`, `month`; default `day`) controls the
        bucketing interval.



        Required headers:


        - `Authorization: Bearer {token}` (requires the `pulse.read` scope)
      operationId: GetPartnerUsageV1
      parameters:
        - name: tenant_ids
          in: query
          description: >-
            Comma-separated tenant UUIDs to scope the list to. Omit to use every
            tenant the caller is authorized for.
          schema:
            type: string
        - name: from
          in: query
          description: Start of the window, RFC 3339. Treated as UTC.
          required: true
          schema:
            type: string
        - name: to
          in: query
          description: End of the window, RFC 3339. Treated as UTC.
          required: true
          schema:
            type: string
        - name: grain
          in: query
          description: Usage reporting grain.
          schema:
            enum:
              - day
              - month
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerUsageResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '503':
          description: Service Unavailable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    PartnerUsageResponse:
      required:
        - root_tenant_id
        - grain
        - from
        - to
        - coverage
        - items
      type: object
      properties:
        root_tenant_id:
          type: string
          format: uuid
        grain:
          type: string
        from:
          type: string
          format: date
        to:
          type: string
          format: date
        coverage:
          type: array
          items:
            $ref: '#/components/schemas/PartnerTenantCoverage'
        items:
          type: array
          items:
            $ref: '#/components/schemas/TenantEndpointHistoryPoint'
    ProblemDetails:
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
    PartnerTenantCoverage:
      required:
        - tenant_id
        - tenant_host
      type: object
      properties:
        tenant_id:
          type: string
          format: uuid
        tenant_host:
          type: string
    TenantEndpointHistoryPoint:
      required:
        - tenant_id
        - period_start
        - endpoint_count
        - email_count
      type: object
      properties:
        tenant_id:
          type: string
          format: uuid
        period_start:
          type: string
          format: date
        endpoint_count:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int64
        email_count:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          format: int64
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        A Tenant Authority machine-client token from POST /v1/auth/client-token,
        carrying subject_type=machine_client and the pulse.read scope.
      scheme: bearer
      bearerFormat: JWT

````