Skip to main content
POST
Brand Mentions API

Brand Mentions

Each row is a page somewhere on the web that mentions your query: blog reviews, news coverage, forum threads, product listings. Next to the URL and title you get the passage around the mention, the author when given, the page’s language and country, its site type, a positive/negative/neutral sentiment split for the passage, six emotion scores, and authority and spam scores for the page and its domain. Filter to news or forums only with content_type, and wrap a phrase in double quotes to match it exactly.
Provide a brand, product or topic in query (up to 100 characters). content_type limits results to news, blogs, message-boards, ecommerce or organization sites. results_limit defaults to 100 and accepts integers from 1 to 1000. Each request costs 10 credits plus 0.02 credits per page; the 10 credits also apply when no page is found.

Standard Result Fields

Task results use the stable SocQ fields below. Source-specific field names and formats are normalized without inferring or enriching values that the source did not provide. To request a smaller field set, use fields for MCP queries, _result_fields for typed tools, or --result-fields in the CLI. Declared fields remain present when their value is null. The following example shows the response format for a completed task. Actual data depends on your query.

Completed Task Response

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Provide a brand, product or topic in query. Each row is one web page that mentions it, with the page's sentiment and emotion scores, author, date, site type and authority. results_limit defaults to 100 and accepts integers from 1 to 1000.

query
string
required

Brand, product or topic to look for. Wrap a phrase in double quotes to match it exactly.

Minimum string length: 1
callback_url
string<uri>
content_type
enum<string>

Kind of site to take mentions from: news, blogs, message-boards, ecommerce or organization.

Available options:
blogs,
ecommerce,
message-boards,
news,
organization
Minimum string length: 1
results_limit
integer
default:100
Required range: 1 <= x <= 1000

Response

Task accepted

code
integer
data
object