Organizations

Get plan usage for one meter

Usage against the plan's included quota for one meter — tracked_videos, tracked_accounts, active_creators, creator_invites_daily, active_jobs, team_seats, or extra_credits. Available to every member, unlike /organization/subscription.

get/organization/meters/{eventName}

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/organization/meters/{eventName}
  • Auth: API key in header x-api-key

Path parameters

eventName'team_seats' | 'tracked_accounts' | 'tracked_videos' | 'active_creators' | 'creator_invites_daily' | 'active_jobs' | 'extra_credits' required

Response

OK

Example response

{
  "meter": {
    "id": "mtr_123",
    "name": "Tracked Videos",
    "eventName": "tracked_videos"
  },
  "benefit": {
    "properties": {
      "units": 100
    }
  },
  "price": {
    "unitAmount": 15,
    "recurringInterval": "month"
  },
  "quantities": {
    "total": 120,
    "current": 75,
    "benefited": 100,
    "extra": 20,
    "unused": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.