Hashtags

The hashtags endpoint allows you to retrieve analytics for hashtags across videos. Get insights into hashtag popularity, usage counts, and total view metrics.

GET/hashtags

Get hashtags

Returns hashtag statistics with optional date range filtering and flexible sorting options. Aggregates data across all videos or within a specific date range.

Query parameters

Name
startDate
Type
string
Description
Start date for filtering (YYYY-MM-DD format). Must be provided with endDate.
Name
endDate
Type
string
Description
End date for filtering (YYYY-MM-DD format). Must be provided with startDate.
Name
limit
Type
number
Description
Maximum number of results (1-200). Default is 50.
Name
orderBy
Type
string
Description
Field to sort by: count or views. Default is count.
Name
sort
Type
string
Description
Sort direction: asc or desc. Default is desc.

Request

GET

/hashtags

curl -G https://api.virlo.ai/hashtags \
  -H "Authorization: Bearer {token}" \
  -d startDate=2024-01-01 \
  -d endDate=2024-12-31 \
  -d limit=50 \
  -d orderBy=views \
  -d sort=desc

Response

{
  "results": 3,
  "data": [
    {
      "hashtag": "viral",
      "count": 15234,
      "total_views": 456789000
    },
    {
      "hashtag": "trending",
      "count": 12456,
      "total_views": 234567000
    },
    {
      "hashtag": "fyp",
      "count": 45678,
      "total_views": 123456000
    }
  ]
}

Error responses

The hashtags endpoint may return the following error codes:

Name
400 Bad Request
Description
Invalid parameters provided. Common causes include: - Invalid date format (must be YYYY-MM-DD) - Providing only one of startDate/endDate (both required together) - Invalid orderBy value (must be 'count' or 'views') - Invalid sort value (must be 'asc' or 'desc')
Name
401 Unauthorized
Description
Missing or invalid API key. Ensure you're including your API key in the Authorization header.
Name
429 Too Many Requests
Description
Rate limit exceeded. Your plan has specific rate limits per endpoint. Wait before making additional requests.