Skip to main content
POST https://xquik.com/api/v1/x/analysis/brand
2 credits per analyzed post · All plans from $0.00012/credit · Supports guest paid reads
Brand monitoring reads each post with AI and answers 3 questions about your brand. The endpoint is POST /api/v1/x/analysis/brand. Name the brand in analysis.targets, with its products and handles as aliases.
The snippets list unhappy customers and print the brand’s totals. They do not print the full response.

Name the brand

Put the brand in analysis.targets, with product names, handles, and common misspellings as aliases. Add analysis.context when the name has other meanings, such as a fruit or city.
relevance is low for namesakes. It is also low for posts that only share a word with the brand. Filter rows on relevance before you count answers. The snippets keep posts from 0.5.

Read the brand answers

results[].answers holds each decision by question ID.sentiment judges the attitude toward your brand, not the post’s general mood.Negative posts from customers are the support queue. Posts from prospects are sales leads.

Track a brand over time

analysisSummary.targets holds each target’s mentions, its share of posts, and its engagement. It also holds the target’s category counts in choices. top holds the target’s most engaged posts per category. Store analysisSummary.targets per run to chart a trend. Name each competitor as its own target to compare brands in 1 call. For more posts than 1 call returns, send the same body again. Set cursor to next_cursor in that body.

Monitor replies & quotes

Send repliesTo with a launch post’s URL to read the replies to it. Send quotesOf to read its quotes. Send username to read 1 account’s posts, such as a competitor’s support account.

Use another brand preset

Set analysis.preset to ask other ready questions about your brand, at the same price. Each needs analysis.targets.

Pick the posts to analyze

Send tweetIds, texts, a page, or a search, never more than 1. See pick the posts to analyze for each source.

Compare with an earlier answer

Send the results of an earlier call as baseline to see what changed. The comparison costs nothing extra. See compare with an earlier answer for an example.

Budget the analysis

Each analyzed post costs 2 credits. Each text in texts costs the same. Posts in unanalyzed cost nothing. See budget the analysis for each reason.

Body

See body parameters for every field. Common ones are tweetIds, texts, query, username, and limit.

Headers

Response

200 OK

400 Invalid input

{ "error": "invalid_input", "message": "Send only 1 of tweetIds, texts & a search such as query or username." } The body names no posts or names more than 1 source. A body with an invalid field gets the same error. The message says what to send instead. The request costs nothing.

401 Unauthenticated

Anonymous requests get WWW-Authenticate: Bearer and a guest wallet checkout action. This is not a Payment challenge. Missing or invalid API key. Check the x-api-key header value.

402 Payment required

Full account keys can receive no_subscription, subscription_inactive, no_credits, or insufficient_credits with account payment options. Guest keys receive only the guest top-up action. The failed request creates no checkout. Ask the user to confirm before calling any checkout or top-up route.

403 Protected account

{ "error": "x_account_protected" } A search that needs a protected author returns this. Choose a public account. The request costs nothing.

502 X API unavailable

The read service returned an error. Retry after a short delay.

503 Service busy

Xquik is busy. Wait for the Retry-After header, then send the request again. The request costs nothing.

429 Rate limit exceeded

You exceeded your tier rate limit. Wait for the Retry-After header before retrying.

424 Dependency failed

The normalized v1 response contract can return 424 when the read service is unavailable.

Brand monitoring API questions

How do I monitor brand mentions on X?

Search the brand’s names in query and name the brand in analysis.targets. Each row in results holds the post and its relevance, sentiment, and experience answers.

How do I find customers who need help?

Keep rows whose sentiment is negative and whose experience is customer. For the problem and its urgency, set analysis.preset to complaints.

Can I compare my brand with competitors?

Yes. Name each brand as its own target. analysisSummary.targets counts the mentions and sentiment of each one.

Does it skip posts about namesakes?

The AI answers relevance for every post. A namesake, such as a person with the brand’s name, gets a low relevance. Filter on it.

How much does brand monitoring cost?

Each analyzed post costs 2 credits. Posts in unanalyzed and refused requests cost nothing.

Does this replace X’s official API?

No. This page documents Xquik, an independent third-party service. It does not document X’s official API.
Next steps. Sentiment analysis reads the attitude of any post. Classify posts asks your own questions.

Response examples

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required." }
  • 402 { "error": "insufficient_credits", "message": "Insufficient credits. Top up or subscribe to continue." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 424 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }
  • 502 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }
  • 503 { "error": "x_api_unavailable", "message": "Xquik is busy right now. Retry shortly." }