Sign in
v1

List billable feature usage logs

Returns a paginated list of billable feature usage logs for your organization. Each entry represents a token consumption event (e.g. a dive, rank radar creation, AI copywriter prompt). Optionally filter by feature type, user name/email, and date range.

get/v1/usage

Query parameters

type'DIVED_ASINS' | 'PRODUCT_BRIEF_ASINS' | 'AI_COPYWRITER_PROMPTS' | 'RANK_RADAR_KEYWORDS' | 'INDEXING_DIAGNOSIS'

Filter by billable feature type

searchstring
Example:john

Search by user name or email (case-insensitive partial match)

startDatestring
Example:2024-01-01T00:00:00Z

Filter usage logs created on or after this date (ISO 8601)

endDatestring
Example:2024-12-31T23:59:59Z

Filter usage logs created on or before this date (ISO 8601)

currentPagenumber
Example:1

Page of items to retrieve (default 1)

pageSizenumber
Example:50

Items per page (default 50, max 200)

Response

currentPagenumber required
pageSizenumber required

Number of items per page

hasNextboolean required

True when there is a next page. Otherwise, false

hasPrevboolean required

True when there is a previous page. Otherwise, false

lastPagenumber required

Last page or total page count

totalnumber required

Total number of items

Example response

{
  "currentPage": 1,
  "pageSize": 20,
  "lastPage": 1,
  "total": 1,
  "data": [
    {
      "name": "John Doe",
      "email": "johndoe@example.com",
      "qty": 1,
      "nicheId": "boGkBnlEx4",
      "nicheName": "dog hat",
      "rankRadarId": "5231a9af-82f2-4c87-9ed4-cef0447cff1e"
    }
  ]
}

Changes