Skip to content

API referenceCollections

Rank the members

GET/v1/collections/{id}/members

The members ranked, highest first, on their latest Snapshot and Scores, with each member's Tracker and its state. Nothing is fetched: a member that has not cycled yet ranks last with nulls.

Price

Free.

Parameters

NameInTypeRequiredDefaultDescription
idpathstringRequired—Collection id.
order_byquerystringone of followers, median_views, outlier, viewsOptional—followers, median_views, outlier or views. Defaults to followers for a creator Collection, views otherwise. Ties keep the order members were added.
platformsquerystringOptional—Comma-separated, or repeated. Omit for every Platform.
limitqueryintegermin 1; max 100Optional25Items per page.
cursorquerystringOptional—Opaque next_cursor from the previous page.

Responses

200 OK

{ order_by, items, next_cursor }.

object

  • itemsarray of objectrequired
    • rankintegerrequired1-based, across the whole filtered ranking rather than the page.
    • trackerobjectrequiredThe member, state included.
      • idstringrequired
      • kindstringrequiredone of creator, hashtag, sound, advertiser, videovideo is deprecated (ADR 0024): existing Video Trackers keep working, new ones are refused with 400 kind_deprecated.
      • platformstringrequiredmeta for an advertiser Tracker.
      • targetstringrequired
      • intelligencebooleanrequiredWhether each new video (or Ad) the cycle finds is analysed.
      • statestringrequiredone of active, paused, deleted
      • last_cycle_atstringrequirednullable
      • last_run_idstringrequirednullable
      • created_atstringrequired
      • updated_atstringrequired
    • snapshot_atstringrequirednullableWhen the numbers were taken. Null when it has not cycled yet.
    • followersnumberrequirednullableCreators: followers at the latest Snapshot.
    • viewsnumberrequirednullableCreators: views across their last 20 videos. Videos, hashtags and sounds: views at the latest Snapshot.
    • median_viewsnumberrequirednullableThe creator's baseline median; for a video, its creator's.
    • outliernumberrequirednullableCreators: the best views / median_views among their last 20 videos. Videos: their own.
  • next_cursorstringrequirednullablePass back as cursor. Null on the last page.
  • order_bystringrequiredone of followers, median_views, outlier, viewsThe metric the ranking used.

200 · `{ order_by, items, next_cursor }`.

{
  "order_by": "followers",
  "items": [
    {
      "rank": 1,
      "tracker": {
        "id": "trk_4b1e90c7aa",
        "kind": "creator",
        "platform": "tiktok",
        "target": "someone",
        "intelligence": true,
        "state": "active",
        "last_cycle_at": "2026-09-08T04:00:11.402Z",
        "last_run_id": "run_c07a41bb92",
        "created_at": "2026-09-01T11:20:03.118Z",
        "updated_at": "2026-09-08T04:00:11.402Z"
      },
      "snapshot_at": "2026-09-08T04:00:11.402Z",
      "followers": 1284000,
      "views": 9812400,
      "median_views": 212000,
      "outlier": 6.06
    }
  ],
  "next_cursor": null
}

400 Bad Request

invalid_request (or unsupported_platform for an unknown entry in platforms) — an unknown order_by, or a cursor that is not a previous next_cursor.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

  • typestringrequired
  • titlestringrequired
  • statusintegerrequired
  • codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_errorStable machine-readable code.
  • detailstring

400 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "code": "invalid_request",
  "detail": "`order_by` must be one of followers, median_views, outlier, views."
}

401 Unauthorized

missing_authorization, invalid_key, key_revoked or invalid_token.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

  • typestringrequired
  • titlestringrequired
  • statusintegerrequired
  • codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_errorStable machine-readable code.
  • detailstring

401 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_key",
  "title": "Invalid key",
  "status": 401,
  "code": "invalid_key",
  "detail": "That API key does not exist. Keys look like `sk_live_...` and are created in the console."
}

404 Not Found

not_found.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

  • typestringrequired
  • titlestringrequired
  • statusintegerrequired
  • codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_errorStable machine-readable code.
  • detailstring

404 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No Collection with that id for this Customer."
}

Request samples

curl "https://www.shortsintel.com/v1/collections/col_7d20e1b5c4/members?order_by=followers&platforms=tiktok%2Cinstagram&limit=25" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"