Appearance
Count by Keyword
POST
/v2/organizations/{organizationId}/keywords/{keywordId}/mentions/countParameters
Path Parameters
organizationIdinteger (int64)requiredpathThe unique identifier of the organization.
keywordIdinteger (int32)requiredpathThe unique identifier of the keyword to count mentions for.
Request Body
The request body contains a query object of type FeedsSearchQueryRequest with the following structure:
| Field | Type | Description |
|---|---|---|
query.feeds | array | Array of feed objects with groupId (int64) and keywordId (int64) to scope the search. Optional -- omit to search all feeds. |
query.feedTime | object | Time range filter based on when the mention entered the feed. Use relative (enum) for preset ranges, or from/to (ISO datetime) for custom ranges. |
query.publishedTime | object | Time range filter based on when the mention was published. Same structure as feedTime. |
query.mentionFilter | object | Filter criteria for narrowing mentions. |
Relative Time Period Values
TODAY, YESTERDAY, LAST_24_HOURS, LAST_7_DAYS, LAST_30_DAYS, LAST_90_DAYS, THIS_MONTH, THIS_WEEK, LAST_WEEK, LAST_MONTH
Mention Filters
Each filter field uses a FilterClause pattern with optional any, all, must, and not sub-fields:
| Filter Field | Type | Description |
|---|---|---|
mentionType | FilterClause | Filter by source type. Values: WEB, FACEBOOK, TWITTER, FORUM, COMMENT, YOUTUBE, INSTAGRAM, REDDIT, TIKTOK, PRINT, RADIO, TV, BLUESKY |
sentiment | FilterClause | Filter by sentiment. Values: POSITIVE, NEUTRAL, NEGATIVE, UNDEFINED |
Try it
Parameters
Organization ID
Keyword ID
Time Range
Filters
Filter by source type
Filter by sentiment
Response
json
{
"count": 1523,
"typeToCount": {
"WEB": 890,
"TWITTER": 423,
"FACEBOOK": 210
}
}Response Fields
| Field | Type | Description |
|---|---|---|
count | integer (int64) | Total number of mentions matching the query for this keyword |
typeToCount | object | Breakdown of mention counts by source type. Keys are source type strings (e.g. WEB, TWITTER), values are counts. |