---
title: "Get feature usage time series"
method: GET
path: "/feature-usage-timeseries"
tags: ["entitlements"]
---

# Get feature usage time series

`GET /feature-usage-timeseries`

## Query parameters

- `company_id` string, required
- `end_time` string, date-time, required
- `feature_id` string, required
- `granularity` 'daily' | 'hourly' | 'monthly' | 'weekly'
- `start_time` string, date-time, required

## Response `200`

OK

- object
  - `data` FeatureUsageTimeSeriesResponseData, required
    - `feature_id` string, required
    - `feature_type` 'boolean' | 'event' | 'license' | 'trait', required
    - `limits` LimitTimeSeriesPointResponseData[], required
      - `effective_at` string, date-time, required
      - `is_soft_limit` boolean, required
      - `limit_source` 'company_override' | 'plan_entitlement' | 'unknown', required
      - `limit_value` integer, nullable
      - `plan_id` string, nullable
      - `price_behavior` 'credit_burndown' | 'overage' | 'pay_as_you_go' | 'pay_in_advance' | 'tier'
    - `period_type` string, nullable
    - `usage_points` UsageTimeSeriesPointResponseData[], required
      - `period_end` string, date-time, nullable
      - `period_start` string, date-time, nullable
      - `timestamp` string, date-time, required
      - `usage` integer, required
  - `params` object, required — Input parameters
    - `company_id` string
    - `end_time` string, date-time
    - `feature_id` string
    - `granularity` 'daily' | 'hourly' | 'monthly' | 'weekly'
    - `start_time` string, date-time

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

---

[API](https://skmtc.net/schematichq/apis/schematic-api.md) · [All operations](https://skmtc.net/schematichq/apis/schematic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/schematichq/schematic-api/revisions/419cb5147b52/schema)
