All pages
Powered by GitBook
1 of 1

Loading...

Hashtag Analysis

The Hashtag Analysis endpoints help you understand how hashtags perform across your workspace or a specific account. Use them to rank, filter, and retrieve top posts for any hashtag.

Requirements

Authentication: Bearer API token Scope: analytics Headers:

  • Authorization: Bearer-API YOUR_API_KEY

  • Publer-Workspace-Id: YOUR_WORKSPACE_ID

Endpoints

1. Get Hashtag Insights

Retrieve aggregated analytics for hashtags used in published posts. Supports filtering by date range, account, member, and search, plus sorting and pagination.

GET /api/v1/analytics/:account_id/hashtag_insights

Description

Returns a paginated list of hashtags with totals for posts, reach, engagement, and related metrics, plus up to 3 recent posts per hashtag and a hashtag performance score.

URL Parameter

Parameter
Type
Required
Description

account_id

string

No

Limit to a single social account. Omit for all workspace accounts.

Query Parameters

Param
Type
Required
Description

from

date (YYYY-MM-DD)

No

Start date (inclusive).

to

date (YYYY-MM-DD)

No

End date (inclusive).

sort_by

string

No

One of: posts, reach, likes, comments, shares, video_views. Default posts.

sort_type

string

No

ASC or DESC. Default DESC.

page

integer

No

Page number (0‑based). Each page contains 10 hashtags. Default 0.

query

string

No

Case‑insensitive filter by hashtag text.

member_id

string

No

Filter hashtags by posts authored/managed by a .

Fields:

  • records[]: One row per hashtag.

    • hashtag: Text without #.

    • posts: Number of posts using it.

    • recent_posts[]: Up to 3 recent posts { id, text, scheduled_at }.

    • Totals: reach, likes, comments, shares, engagement, video_views, link_clicks, post_clicks, saves.

    • hashtag_score (%): Relative performance = (total hashtag engagement / total post engagement) × 100.

  • total: Total hashtags matching filters.

2. Get Hashtag Performing Posts

Retrieve up to 6 top posts that used a specific hashtag, with full per‑post analytics.

GET /api/v1/analytics/hashtag_performing_posts

URL Parameter

Parameter
Type
Required
Description

account_id

string

No

Limit to a single social account. Omit for all workspace accounts.

Query Parameters

Param
Type
Required
Description

hashtag

string

Yes

Hashtag to analyze (with #).

from

date (YYYY-MM-DD)

No

Start date (inclusive).

to

date (YYYY-MM-DD)

No

End date (inclusive).

sort_by

string

No

One of: scheduled_at, reach, engagement, engagement_rate, click_through_rate, reach_rate, postType, likes, video_views, comments, shares, saves, link_clicks, post_clicks. Default scheduled_at.

sort_type

string

No

ASC or DESC. Default DESC.

member_id

string

No

Filter by post author/manager.

query

string

No

Text search in post text/title/link info.

Notes

  • Time range: Defaults to the workspace’s default range when not provided. “Last X Days” excludes partial data for the current day.

  • Sorting & ranking: Use sort_by and sort_type to rank by Posts, Reach, Reactions (likes), Comments, Shares, or Video Views. UI columns can be reordered client‑side.

  • Data freshness: Insights auto‑refresh every ~24h; you can manually sync in the UI for real‑time updates.

  • Platform differences: Metrics availability varies by social network/account type; missing fields may be null or omitted.

  • Pagination (insights list): page is 0‑based and returns 10 hashtags per page.

  • Hashtag score: hashtag_score (%) = (total hashtag engagement / total post engagement) × 100.

Related Resources

  • Post Insights — Per‑post performance analytics

  • Charts — Discover chart IDs and fetch chart data

  • Best Times — Suggested posting time slots

  • Members — Member (team) analytics

member

Get Hashtag Insights

get

Retrieves comprehensive analytics data for hashtags used in published posts. Provides metrics like reach, engagement, likes, comments, shares, and video views for each hashtag, along with recent posts using each hashtag and hashtag performance scores.

Path parameters
account_idstringOptional

Filter hashtags for a specific social media account ID. If omitted, includes all workspace accounts

Query parameters
fromstring · dateOptional

Start date for hashtag insights data range (YYYY-MM-DD format). Filters posts scheduled on or after this date

Example: {"value":"2024-01-01"}
tostring · dateOptional

End date for hashtag insights data range (YYYY-MM-DD format). Filters posts scheduled on or before this date

Example: {"value":"2024-12-31"}
sort_bystring · enumOptional

Field to sort hashtag results by. Supports various engagement and performance metrics

Possible values:
sort_typestring · enumOptional

Sort order direction

Possible values:
pageintegerOptional

Page number for pagination (0-based indexing). Each page contains 10 hashtags

querystringOptional

Search query to filter hashtags by name using case-insensitive matching

member_idstringOptional

Filter hashtags by specific workspace member ID

Header parameters
Publer-Workspace-IdstringRequired

ID of the workspace to retrieve insights from

Responses
200

Hashtag insights data with analytics metrics and pagination information

application/json
401

Unauthorized

application/json
403

Permission denied - requires analytics access or paying subscription

application/json
get
GET /api/v1/analytics/{account_id}/hashtag_insights HTTP/1.1
Host: app.publer.com
Publer-Workspace-Id: text
Accept: */*
{
  "records": [
    {
      "hashtag": "socialmedia",
      "posts": 1,
      "recent_posts": [
        {
          "id": "text",
          "text": "text",
          "scheduled_at": "2025-08-20T23:49:41.790Z"
        }
      ],
      "reach": 1,
      "likes": 1,
      "comments": 1,
      "shares": 1,
      "engagement": 1,
      "video_views": 1,
      "link_clicks": 1,
      "post_clicks": 1,
      "saves": 1,
      "hashtag_score": 1
    }
  ],
  "total": 1
}

Get Hashtag Performing Posts

get

Retrieves the top performing posts for a specific hashtag. Returns up to 6 posts that used the hashtag, with comprehensive analytics metrics including engagement, reach, likes, comments, shares, and video views.

Path parameters
account_idstringOptional

Filter posts for a specific social media account ID. If omitted, includes all workspace accounts

Query parameters
hashtagstringRequired

The hashtag to retrieve performing posts for (with # symbol). This parameter is required to filter posts by the specific hashtag

Example: {"value":"socialmedia"}
fromstring · dateOptional

Start date for posts data range (YYYY-MM-DD format). Filters posts scheduled on or after this date

Example: {"value":"2024-01-01"}
tostring · dateOptional

End date for posts data range (YYYY-MM-DD format). Filters posts scheduled on or before this date

Example: {"value":"2024-12-31"}
sort_bystring · enumOptional

Field to sort post results by. Supports various engagement and performance metrics

Possible values:
sort_typestring · enumOptional

Sort order direction

Possible values:
member_idstringOptional

Filter posts by specific workspace member ID

querystringOptional

Search query to filter posts by content text, title, or link information using case-insensitive matching

Header parameters
Publer-Workspace-IdstringRequired

ID of the workspace to retrieve posts from

Responses
200

Hashtag performing posts data with analytics metrics

application/json
401

Unauthorized

application/json
403

Permission denied - requires analytics access or paying subscription

application/json
get
GET /api/v1/analytics/{account_id}/hashtag_performing_posts HTTP/1.1
Host: app.publer.com
Publer-Workspace-Id: text
Accept: */*
[
  {
    "id": "text",
    "text": "text",
    "title": "text",
    "scheduled_at": "2025-08-20T23:49:41.790Z",
    "account_id": "text",
    "hashtags": [
      "text"
    ],
    "analytics": {
      "reach": 1,
      "likes": 1,
      "comments": 1,
      "shares": 1,
      "engagement": 1,
      "engagement_rate": 1,
      "video_views": 1,
      "link_clicks": 1,
      "post_clicks": 1,
      "saves": 1
    },
    "details": {
      "labels": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  }
]