List feature usage history

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.entitlements.listFeatureUsageHistory({
        endTime: new Date("end_time"),
        startTime: new Date("start_time"),
    });
}
main();

{
  "data": [
    {
      "company_id": "string",
      "event_subtype": "string",
      "feature_id": "string",
      "period_end": "2024-01-15T09:30:00Z",
      "period_start": "2024-01-15T09:30:00Z",
      "usage": 1
    }
  ],
  "params": {
    "company_ids": [
      "string"
    ],
    "end_time": "2024-01-15T09:30:00Z",
    "feature_ids": [
      "string"
    ],
    "granularity": "daily",
    "limit": 100,
    "offset": 0,
    "start_time": "2024-01-15T09:30:00Z"
  }
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idslist of stringsOptional

Restrict to these company IDs; omit for every company in the environment

end_timedatetimeRequired

Exclusive end of the window; must fall on an hour boundary

feature_idslist of stringsOptional

Restrict to these event features; omit for every event feature in the environment. Where several features measure the same event, each is reported separately and a page may carry more rows than the requested limit

granularityenumOptional

Bucket the window; omit for a single total per company and feature

Allowed values:

start_timedatetimeRequired

Inclusive start of the window; must fall on an hour boundary

limitlongOptional0-250

Page limit (default 100)

offsetlongOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error