Skip to main content
GET
/
credits
/
usage
Get Credit Usage
curl --request GET \
  --url https://api.example.com/credits/usage
Returns aggregated credit usage over a date range. The response includes:
  • totals across the range
  • grouped usage by tile
  • grouped usage by date
  • grouped usage by both date and tile
Tile names (for example YouTube Download, Rough Cut, Clips) are resolved from node metadata associated with each credit log.

​
Query Parameters

ParameterTypeRequiredDescription
start_datestringNoISO date/datetime start bound. Defaults to 30 days before end_date.
end_datestringNoISO date/datetime end bound. Defaults to now.
limitnumberNoMax raw usage events scanned (1 - 10,000). Default: 5,000.

​
Request

curl -X GET "https://api.mosaic.so/credits/usage?start_date=2026-03-01T00:00:00.000Z&end_date=2026-03-31T23:59:59.999Z&limit=5000" \
  -H "Authorization: Bearer mk_your_api_key"

​
Response

{
  "organization_id": "d808af70-fc57-4f90-95ca-186a9cbf2ef7",
  "date_range": {
    "start_date": "2026-03-01T00:00:00.000Z",
    "end_date": "2026-03-31T23:59:59.999Z"
  },
  "summary": {
    "total_credits_used": 14220,
    "total_events": 298,
    "matching_events": 298,
    "returned_events": 298,
    "truncated": false
  },
  "breakdown": {
    "by_tile": [
      {
        "tile_id": "a4c6ee9a-4ff2-43f8-9a9a-d4ad6dd20f3a",
        "tile_name": "Rough Cut",
        "credits_used": 7210,
        "events": 142
      },
      {
        "tile_id": "3cfd7bcb-f4cb-4bd3-8f81-a3de9af16f14",
        "tile_name": "Clips",
        "credits_used": 5030,
        "events": 101
      }
    ],
    "by_date": [
      {
        "date": "2026-03-01",
        "credits_used": 420,
        "events": 11
      },
      {
        "date": "2026-03-02",
        "credits_used": 388,
        "events": 9
      }
    ],
    "by_date_and_tile": [
      {
        "date": "2026-03-01",
        "tile_id": "a4c6ee9a-4ff2-43f8-9a9a-d4ad6dd20f3a",
        "tile_name": "Rough Cut",
        "credits_used": 420,
        "events": 11
      }
    ]
  }
}

​
Response Fields

FieldTypeDescription
organization_idstringOrganization identifier.
date_range.start_datestringStart of the queried range (ISO).
date_range.end_datestringEnd of the queried range (ISO).
summary.total_credits_usednumberTotal credits consumed in the returned range.
summary.total_eventsnumberNumber of charge events included in aggregation.
summary.matching_eventsnumberTotal matching events before limit truncation.
summary.returned_eventsnumberNumber of events processed in this response window.
summary.truncatedbooleantrue when matching_events > returned_events.
breakdown.by_tile[].tile_idstringTile/node type identifier.
breakdown.by_tile[].tile_namestring | nullHuman-readable tile name.
breakdown.by_tile[].credits_usednumberCredits used by this tile.
breakdown.by_tile[].eventsnumberNumber of usage events for this tile.
breakdown.by_date[].datestringUTC date (YYYY-MM-DD).
breakdown.by_date[].credits_usednumberCredits used on this date.
breakdown.by_date[].eventsnumberNumber of usage events on this date.
breakdown.by_date_and_tile[].datestringUTC date (YYYY-MM-DD).
breakdown.by_date_and_tile[].tile_idstringTile/node type identifier.
breakdown.by_date_and_tile[].tile_namestring | nullHuman-readable tile name.
breakdown.by_date_and_tile[].credits_usednumberCredits used by this tile on this date.
breakdown.by_date_and_tile[].eventsnumberNumber of usage events for this tile on this date.