Skip to main content
GET
/
v1
/
usage
curl -X GET "https://api.trigify.io/v1/usage" \
  -H "x-api-key: YOUR_API_KEY"

{
  "message": "<string>",
  "success": true,
  "data": {
    "period": {
      "from": "<string>",
      "to": "<string>"
    },
    "credits": {
      "total_consumed": 123,
      "by_feature": {}
    },
    "monitors": {
      "active": 123,
      "total": 123
    },
    "results": {
      "total_collected": 123
    }
  }
}
Retrieve a high-level summary of your account’s resource consumption across credits, monitors, and results.

​
Overview

The Usage Summary endpoint provides a single snapshot of how your account is performing: total credits consumed (broken down by feature), active and total monitors, and total results collected. Use this for dashboards, billing overviews, and quick health checks.

​
Authentication

Requires a valid API key. No special permission scope is needed beyond a valid key.

​
Key Features

  • Credit Overview: Total credits consumed with per-feature detail
  • Monitor Counts: Active versus total monitors at a glance
  • Results Collected: Total results gathered across all searches
  • Period Awareness: Consumption scoped to your current billing period
  • No Credit Cost: This endpoint is free to use
curl -X GET "https://api.trigify.io/v1/usage" \
  -H "x-api-key: YOUR_API_KEY"

​
Example Response

{
  "success": true,
  "data": {
    "period": {
      "start": "2026-03-01T00:00:00.000Z",
      "end": "2026-04-01T00:00:00.000Z"
    },
    "credits": {
      "total_consumed": 1250,
      "by_feature": {
        "search_create": 500,
        "profile_enrich": 350,
        "workflow_execution": 250,
        "social_topics": 150
      }
    },
    "monitors": {
      "active": 12,
      "total": 25
    },
    "results": {
      "total_collected": 8432
    }
  }
}

​
Response Fields

FieldTypeDescription
period.startstringISO 8601 start of the billing period
period.endstringISO 8601 end of the billing period
credits.total_consumedintegerTotal credits consumed in the period
credits.by_featureobjectCredits consumed per feature as key-value pairs
monitors.activeintegerNumber of currently active monitors
monitors.totalintegerTotal monitors created (including paused and completed)
results.total_collectedintegerTotal number of results collected across all searches

​
Credit Usage

This endpoint is free and does not consume credits.

Headers

​
x-api-key
string

Query Parameters

​
from
string

Start date (ISO 8601). Defaults to start of current billing month.

​
to
string

End date (ISO 8601). Defaults to now.

Response

200 - application/json

Usage summary

​
message
string
required
​
success
boolean
required
​
data
object
required