List a research's hashtags

The hashtags a research surfaced, past the 25 it carries inline. Ordered by video_count by default, or by views. One rollup spans every platform the tag was seen on rather than splitting into a row per platform — a research searches several platforms precisely to find what carries across — so platforms=tiktok means "tags that appeared on TikTok" and the row still counts every video carrying the tag anywhere. video_ids are platform:id if you want the split. Paging, total and as_of work exactly as they do on the videos read. A research that has not finished answers 409 run_not_ready.

Open in Playground(no API Key needed)

Price

Free, forever, filtered or not. Collection is the only thing charged.

Parameters

Responses

200 OK

{ items, total, limit, offset, as_of }.

{
  "items": [
    {
      "value": "coldplunge",
      "platforms": [
        "instagram",
        "tiktok"
      ],
      "video_count": 34,
      "total_views": 18402000,
      "video_ids": [
        "tiktok:7300000000000000000",
        "instagram:C9xExampleShortcode"
      ]
    }
  ],
  "total": 62,
  "limit": 25,
  "offset": 0,
  "as_of": "run"
}

400 Bad Request

invalid_request — an unknown platform, an unknown order_by, sort or as_of, a limit outside 1 to 100, or a negative or non-integer offset.

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "code": "invalid_request",
  "detail": "`limit` must be an integer between 1 and 100, and `offset` a non-negative integer."
}

401 Unauthorized

missing_authorization, invalid_key, key_revoked or invalid_token.

{
  "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.

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

409 Conflict

run_not_ready — the research is still running, or failed with nothing to serve. If it is still running, poll GET /v1/runs/{id} and read again once it settles; a failed research never becomes readable.

{
  "type": "https://www.shortsintel.com/docs/reference/errors/run_not_ready",
  "title": "Run not ready",
  "status": 409,
  "code": "run_not_ready",
  "detail": "Research `run_c07a41bb92` is still running. Poll GET /v1/runs/run_c07a41bb92 until it reaches a terminal status."
}

Request samples

curl "https://www.shortsintel.com/v1/research/id_example/hashtags?platforms=tiktok%2Cyoutube&order_by=video_count&sort=desc&limit=25&offset=0&as_of=run" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

const response = await fetch(
  "https://www.shortsintel.com/v1/research/id_example/hashtags?platforms=tiktok%2Cyoutube&order_by=video_count&sort=desc&limit=25&offset=0&as_of=run",
  {
    method: "GET",
    headers: {
      "Authorization": "Bearer sk_live_YOUR_KEY",
    },
  },
);

if (!response.ok) {
  throw new Error(`ShortsIntel ${response.status}`);
}

const data = await response.json();

import requests

response = requests.get(
    "https://www.shortsintel.com/v1/research/id_example/hashtags?platforms=tiktok%2Cyoutube&order_by=video_count&sort=desc&limit=25&offset=0&as_of=run",
    headers={
        "Authorization": "Bearer sk_live_YOUR_KEY",
    },
)
response.raise_for_status()

data = response.json()

Related guides

• Research: How an intent becomes a digest, why a research id is a run id, and how to re-slice what you collected for free instead of paying for it twice.