API docs v1

Spec version v1

API reference

Every Rank Prompt /v1 endpoint, organized by resource. Browse operations, schemas, and copy-paste-ready code samples for cURL, Node.js, and Python.

Resources

Account

6 endpoints

Inspect the principal behind the current API key, the account it acts in, and the request quota for the active billing period.

  1. GET /v1/me Who am I
  2. GET /v1/me/credits Current credit balance
  3. POST /v1/me/credits/purchases Buy a credit pack
  4. GET /v1/me/quota Current quota
  5. POST /v1/me/subscriptions Subscribe to a plan
  6. GET /v1/me/usage Historical usage

Brands

5 endpoints

Create, read, update and delete brands. Brand-restricted API keys are scoped to a single brand and cannot mint new ones.

  1. GET /v1/brands List brands
  2. POST /v1/brands Create a brand
  3. GET /v1/brands/{brand_id} Retrieve a brand
  4. PATCH /v1/brands/{brand_id} Update a brand
  5. DELETE /v1/brands/{brand_id} Delete a brand

Brand facts

3 endpoints

LLM-researched brand profile (description, industry, value proposition, and more). Generated synchronously via POST /v1/brands/{id}/facts; the call may block up to 180s.

  1. GET /v1/brands/{brand_id}/facts Retrieve brand facts
  2. POST /v1/brands/{brand_id}/facts Regenerate brand facts
  3. PATCH /v1/brands/{brand_id}/facts Update brand facts

Reports

15 endpoints

Create, list, retrieve and re-run AI visibility reports. Report creation is asynchronous and returns a job_id you can poll on GET /v1/jobs/{id}.

  1. GET /v1/reports List reports
  2. POST /v1/reports Create a report
  3. GET /v1/reports/{report_id} Retrieve a report
  4. PATCH /v1/reports/{report_id} Update a report
  5. DELETE /v1/reports/{report_id} Delete a report
  6. GET /v1/reports/{report_id}/ai-analysis Get AI analysis
  7. POST /v1/reports/{report_id}/ai-suggestions Generate AI suggestion
  8. GET /v1/reports/{report_id}/competitors List a report's competitors
  9. GET /v1/reports/{report_id}/prompts List report prompts
  10. POST /v1/reports/{report_id}/prompts Add report prompts
  11. DELETE /v1/reports/{report_id}/prompts Clear report prompts
  12. PATCH /v1/reports/{report_id}/prompts/{prompt_id} Update a report prompt
  13. DELETE /v1/reports/{report_id}/prompts/{prompt_id} Delete a report prompt
  14. POST /v1/reports/{report_id}/runs Run analysis
  15. GET /v1/reports/{report_id}/summary Get report summary

Prompts

8 endpoints

Mutate the prompts attached to a report (bulk-create, update, delete), and read every prompt a brand tracks or ran with GET /v1/brands/{brand_id}/prompts: one row per prompt text with its runs, visibility and trend, and the engines' answers to them with GET /v1/brands/{brand_id}/prompts/answers. A report's prompts also come inline on GET /v1/reports/{id} with their per-platform results.

  1. GET /v1/brands/{brand_id}/prompts List brand prompts
  2. PATCH /v1/brands/{brand_id}/prompts Update brand prompts in bulk
  3. GET /v1/brands/{brand_id}/prompts/{prompt_hash}/cited-pages List the pages cited for a prompt
  4. GET /v1/brands/{brand_id}/prompts/{prompt_hash}/content-suggestion Suggest content for a prompt
  5. GET /v1/brands/{brand_id}/prompts/answers List prompt answers
  6. GET /v1/brands/{brand_id}/prompts/answers/{answer_id} Retrieve a prompt answer
  7. GET /v1/brands/{brand_id}/prompts/answers/brands Brands the answers name
  8. GET /v1/brands/{brand_id}/prompts/answers/series Answers per day and engine

Region configs

10 endpoints

Read region configurations attached to a brand. Region configs drive scheduled report fan-out across markets.

  1. GET /v1/region-configs List region configs
  2. POST /v1/region-configs Create a region config
  3. GET /v1/region-configs/{region_config_id} Retrieve a region config
  4. PATCH /v1/region-configs/{region_config_id} Update a region config
  5. DELETE /v1/region-configs/{region_config_id} Delete a region config
  6. GET /v1/region-configs/{region_config_id}/prompts List region config prompts
  7. POST /v1/region-configs/{region_config_id}/prompts Add region config prompts
  8. DELETE /v1/region-configs/{region_config_id}/prompts Clear region config prompts
  9. PATCH /v1/region-configs/{region_config_id}/prompts/{prompt_id} Update a region config prompt
  10. DELETE /v1/region-configs/{region_config_id}/prompts/{prompt_id} Delete a region config prompt

Scheduled reports

12 endpoints

CRUD for scheduled report definitions. Each schedule fires a new report at the configured frequency (daily/weekly/monthly).

  1. GET /v1/scheduled-reports List scheduled reports
  2. POST /v1/scheduled-reports Create a scheduled report
  3. GET /v1/scheduled-reports/{scheduled_report_id} Retrieve a scheduled report
  4. PATCH /v1/scheduled-reports/{scheduled_report_id} Update a scheduled report
  5. DELETE /v1/scheduled-reports/{scheduled_report_id} Delete a scheduled report
  6. GET /v1/scheduled-reports/{scheduled_report_id}/analytics Schedule analytics
  7. POST /v1/scheduled-reports/{scheduled_report_id}/duplicates Duplicate a scheduled report
  8. POST /v1/scheduled-reports/{scheduled_report_id}/executions Run schedule now
  9. GET /v1/scheduled-reports/{scheduled_report_id}/prompt-history/{region_config_prompt_id} Prompt run history
  10. GET /v1/scheduled-reports/{scheduled_report_id}/region-configs List attached region configs
  11. POST /v1/scheduled-reports/{scheduled_report_id}/region-configs/{region_config_id} Attach a region config
  12. GET /v1/scheduled-reports/{scheduled_report_id}/runs List schedule runs

Jobs

3 endpoints

Poll the status of asynchronous jobs (e.g. report generation). Each job is principal-isolated: keys can only see jobs they started; brand-restricted keys can only see jobs for their brand.

  1. GET /v1/jobs List recent jobs
  2. GET /v1/jobs/{job_id} Poll a job
  3. DELETE /v1/jobs/{job_id} Cancel a job

Page audit

1 endpoint

Run a rule-based SEO/AEO best-practice audit on any public page and get an overall score plus concrete recommendations. Costs 1 credit per run; ideal for CI checks via the GitHub Action.

  1. POST /v1/page-audit Audit one or more pages

Citations

15 endpoints

Per-brand URL citations powering the outreach pipeline. List, filter and roll up the pages where the brand appeared (or could appear) across AI assistants, with the Outreach score (field name rankprompt_score), domain authority, mention sentiment and per-platform mention counts.

  1. GET /v1/brands/{brand_id}/citations List citations
  2. GET /v1/brands/{brand_id}/citations/authors List cited authors
  3. GET /v1/brands/{brand_id}/citations/authors/{author_key}/pages List one author's cited pages
  4. GET /v1/brands/{brand_id}/citations/domains List cited domains
  5. GET /v1/brands/{brand_id}/citations/offsite Off-site summary
  6. GET /v1/brands/{brand_id}/citations/offsite/pages List off-site pages
  7. GET /v1/brands/{brand_id}/citations/pages List cited pages
  8. GET /v1/brands/{brand_id}/citations/series Citations over time
  9. GET /v1/brands/{brand_id}/citations/social List cited social posts
  10. GET /v1/brands/{brand_id}/citations/social/groups List cited subreddits, channels and authors
  11. GET /v1/brands/{brand_id}/tracked-pages List pages tracked in Sources
  12. POST /v1/brands/{brand_id}/tracked-pages Track pages
  13. DELETE /v1/brands/{brand_id}/tracked-pages Untrack a page
  14. GET /v1/citations/{citation_id} Retrieve a citation
  15. GET /v1/citations/{citation_id}/backlink-checks List a citation's backlink re-checks

Fanouts

2 endpoints

The web searches the AI engines ran while answering the brand's prompts: what they looked up before citing a page, most frequent first, with the same report, schedule, engine and date filters as the citation reads.

  1. GET /v1/brands/{brand_id}/fanouts List fan-out searches
  2. GET /v1/brands/{brand_id}/fanouts/prompts List the prompts behind a fan-out search

Exports

2 endpoints

A brand's whole citation and answer history as gzipped NDJSON files: start an export, poll it, download the files. The way to read everything, instead of paging the lists.

  1. POST /v1/brands/{brand_id}/exports Export a brand's history
  2. GET /v1/brands/{brand_id}/exports/{export_id} Retrieve an export

Prompt discovery

2 endpoints

Questions and keywords worth tracking, from Search Console, the keywords the domain ranks for, keyword research, one page read by a model, the prompts competitors win and the engines' fan-out searches, each flagged when the brand already tracks it.

  1. GET /v1/brands/{brand_id}/prompt-discoveries List discovered prompts
  2. POST /v1/brands/{brand_id}/prompt-discoveries Discover prompts from a seed or a page

Shares

18 endpoints

Time-limited public share links for reports, scheduled reports, brand summaries and brand audits. Each share is a read-only snapshot resolved at /shared/{access_token}. POST is idempotent; pass rotate=true to invalidate a leaked URL.

  1. GET /v1/brands/{brand_id}/audits/{audit_id}/shares List brand-audit shares
  2. POST /v1/brands/{brand_id}/audits/{audit_id}/shares Create a brand-audit share
  3. DELETE /v1/brands/{brand_id}/audits/{audit_id}/shares Revoke brand-audit shares
  4. PATCH /v1/brands/{brand_id}/audits/{audit_id}/shares/{share_id} Extend a brand-audit share
  5. GET /v1/brands/{brand_id}/shares List brand-summary shares
  6. POST /v1/brands/{brand_id}/shares Create a brand-summary share
  7. DELETE /v1/brands/{brand_id}/shares Revoke brand-summary shares
  8. PATCH /v1/brands/{brand_id}/shares/{share_id} Extend a brand-summary share
  9. GET /v1/reports/{report_id}/shares List shares
  10. POST /v1/reports/{report_id}/shares Create a share
  11. DELETE /v1/reports/{report_id}/shares Revoke shares
  12. PATCH /v1/reports/{report_id}/shares/{share_id} Extend a share
  13. GET /v1/scheduled-reports/{scheduled_report_id}/shares List scheduled-report shares
  14. POST /v1/scheduled-reports/{scheduled_report_id}/shares Create a scheduled-report share
  15. DELETE /v1/scheduled-reports/{scheduled_report_id}/shares Revoke scheduled-report shares
  16. PATCH /v1/scheduled-reports/{scheduled_report_id}/shares/{share_id} Extend a scheduled-report share
  17. GET /v1/shares List the account's shares
  18. DELETE /v1/shares/{share_id} Revoke a share

Alias suggestions

3 endpoints

Detected name variants for a brand that are not yet counted as the brand. Accept the correct ones so future reports attribute those mentions, or dismiss the wrong ones.

  1. GET /v1/brands/{brand_id}/alias-suggestions List alias suggestions
  2. DELETE /v1/brands/{brand_id}/alias-suggestions/{business_name} Dismiss an alias suggestion
  3. POST /v1/brands/{brand_id}/alias-suggestions/{business_name}/acceptances Accept an alias suggestion

Competitors

6 endpoints

The brand's cross-report competitor registry: entities that show up alongside it in AI answers, ranked by share of voice. Reclassify, merge duplicates, or remove entities to keep the registry accurate.

  1. GET /v1/brands/{brand_id}/competitors List competitors
  2. PATCH /v1/brands/{brand_id}/competitors/{competitor_id} Update a competitor
  3. DELETE /v1/brands/{brand_id}/competitors/{competitor_id} Delete a competitor
  4. GET /v1/brands/{brand_id}/competitors/duplicates List likely duplicate competitors
  5. POST /v1/brands/{brand_id}/competitors/merges Merge duplicate competitors
  6. GET /v1/brands/{brand_id}/competitors/summary Competitor share of voice

Content

51 endpoints

Report-driven content opportunities, ranked by impact: topics where competitors are cited and the brand is not. The highest-leverage list for AEO content work.

  1. GET /v1/brands/{brand_id}/cms-connections List CMS connections
  2. POST /v1/brands/{brand_id}/cms-connections Connect a CMS
  3. GET /v1/brands/{brand_id}/cms-connections/{connection_id} Retrieve a CMS connection
  4. DELETE /v1/brands/{brand_id}/cms-connections/{connection_id} Delete a CMS connection
  5. POST /v1/brands/{brand_id}/cms-connections/{connection_id}/checks Check a CMS connection
  6. GET /v1/brands/{brand_id}/content-autopilot Read the brand's content autopilot
  7. PATCH /v1/brands/{brand_id}/content-autopilot Set up, change, pause or resume the content autopilot
  8. GET /v1/brands/{brand_id}/content-briefs List content briefs
  9. POST /v1/brands/{brand_id}/content-briefs Create a content brief
  10. GET /v1/brands/{brand_id}/content-briefs/{brief_id} Retrieve a content brief
  11. PATCH /v1/brands/{brand_id}/content-briefs/{brief_id} Date a content brief on the calendar
  12. DELETE /v1/brands/{brand_id}/content-briefs/{brief_id} Delete a content brief
  13. PATCH /v1/brands/{brand_id}/content-briefs/{brief_id}/assets Edit a generated article
  14. POST /v1/brands/{brand_id}/content-briefs/{brief_id}/generations Write the article again
  15. GET /v1/brands/{brand_id}/content-briefs/{brief_id}/interlinks List the posts that could link to an article
  16. POST /v1/brands/{brand_id}/content-briefs/{brief_id}/interlinks/{interlink_id}/applications Add the link to the post
  17. POST /v1/brands/{brand_id}/content-briefs/{brief_id}/interlinks/{interlink_id}/dismissals Leave the post as it is
  18. POST /v1/brands/{brand_id}/content-briefs/{brief_id}/outlines Outline a content brief
  19. POST /v1/brands/{brand_id}/content-briefs/{brief_id}/publish Publish a content brief
  20. PATCH /v1/brands/{brand_id}/content-briefs/{brief_id}/publish-schedules/{schedule_id} Move a scheduled publish
  21. DELETE /v1/brands/{brand_id}/content-briefs/{brief_id}/publish-schedules/{schedule_id} Cancel a scheduled publish
  22. GET /v1/brands/{brand_id}/content-briefs/{brief_id}/review Retrieve an article's review
  23. POST /v1/brands/{brand_id}/content-briefs/{brief_id}/review/comments Reply on an article's review
  24. PATCH /v1/brands/{brand_id}/content-briefs/{brief_id}/review/comments/{comment_id} Resolve a review comment
  25. PUT /v1/brands/{brand_id}/content-briefs/{brief_id}/review/share Share an article for review
  26. DELETE /v1/brands/{brand_id}/content-briefs/{brief_id}/review/share Revoke an article's review link
  27. GET /v1/brands/{brand_id}/content-briefs/ai-traffic AI visits per article
  28. GET /v1/brands/{brand_id}/content-briefs/citation-uplift Did the articles move the citations
  29. POST /v1/brands/{brand_id}/content-briefs/generations Generate an article asynchronously
  30. POST /v1/brands/{brand_id}/content-briefs/manual Create a content brief from your own article
  31. GET /v1/brands/{brand_id}/content-calendar Read the content calendar
  32. GET /v1/brands/{brand_id}/content-calendar/undated List the undated articles
  33. GET /v1/brands/{brand_id}/content-opportunities List content opportunities
  34. POST /v1/brands/{brand_id}/content-opportunities/refreshes Recompute the opportunities
  35. POST /v1/brands/{brand_id}/content-optimizations Optimize an existing page
  36. POST /v1/brands/{brand_id}/content-plans Generate a batch of articles
  37. GET /v1/brands/{brand_id}/content-plans/{batch_id} Follow a batch of articles
  38. GET /v1/brands/{brand_id}/content-preferences Read how this brand's articles are written
  39. PATCH /v1/brands/{brand_id}/content-preferences Set how this brand's articles are written
  40. POST /v1/brands/{brand_id}/content-preferences/voice-extractions Learn this brand's voice from its site
  41. POST /v1/brands/{brand_id}/github/blog-scaffolds Add a blog to the repository
  42. GET /v1/brands/{brand_id}/github/publishing-profile Read the GitHub publishing profile
  43. POST /v1/brands/{brand_id}/github/publishing-profile-inferences Read the repository's blog again
  44. GET /v1/brands/{brand_id}/knowledge-base List the knowledge base
  45. POST /v1/brands/{brand_id}/knowledge-base Add a note or a web page
  46. PATCH /v1/brands/{brand_id}/knowledge-base/{item_id} Change a knowledge item
  47. DELETE /v1/brands/{brand_id}/knowledge-base/{item_id} Delete a knowledge item
  48. POST /v1/brands/{brand_id}/knowledge-base/files Upload a file to the knowledge base
  49. GET /v1/brands/{brand_id}/knowledge-base/search Search the knowledge base
  50. GET /v1/brands/{brand_id}/publish-targets List where articles can be published
  51. GET /v1/brands/{brand_id}/site-pages List the site index

Brand audits

6 endpoints

Full AI-visibility audits for a single market (country + language), with generated recommendations and citation analysis. Audit runs cost credits.

  1. GET /v1/brands/{brand_id}/audits List brand audits
  2. POST /v1/brands/{brand_id}/audits Run a brand audit
  3. GET /v1/brands/{brand_id}/audits/{audit_id} Retrieve a brand audit
  4. POST /v1/brands/{brand_id}/audits/{audit_id}/citations Analyze audit citations
  5. POST /v1/brands/{brand_id}/audits/{audit_id}/recommendations Generate audit recommendations
  6. POST /v1/brands/{brand_id}/audits/runs Run a brand audit asynchronously

SEO keywords

29 endpoints

Track Google keywords for a brand: positions over time, search volume and difficulty, keyword research, the organic overview and keyword gap against competitors, and the Google keyword behind each AI prompt. Buying provider data costs credits.

  1. POST /v1/brands/{brand_id}/seo/competitor-domains Add a competitor site
  2. DELETE /v1/brands/{brand_id}/seo/competitor-domains/{domain} Remove a competitor site
  3. GET /v1/brands/{brand_id}/seo/domains/{domain}/ranking-keywords List a site's ranking keywords
  4. POST /v1/brands/{brand_id}/seo/domains/{domain}/ranking-keywords/refreshes Load a site's ranking keywords
  5. GET /v1/brands/{brand_id}/seo/keyword-clusters List keyword clusters
  6. POST /v1/brands/{brand_id}/seo/keyword-clusters/recomputes Rebuild keyword clusters
  7. POST /v1/brands/{brand_id}/seo/keyword-clusters/serp-checks Check SERPs to group keywords
  8. GET /v1/brands/{brand_id}/seo/keyword-gap Get the keyword gap
  9. POST /v1/brands/{brand_id}/seo/keyword-gap/refreshes Refresh the keyword gap
  10. POST /v1/brands/{brand_id}/seo/keyword-research Research keywords
  11. GET /v1/brands/{brand_id}/seo/keywords List the keyword library
  12. POST /v1/brands/{brand_id}/seo/keywords Track keywords
  13. DELETE /v1/brands/{brand_id}/seo/keywords Stop tracking several keywords
  14. PATCH /v1/brands/{brand_id}/seo/keywords/{keyword_id} Update a tracked keyword
  15. DELETE /v1/brands/{brand_id}/seo/keywords/{keyword_id} Stop tracking a keyword
  16. GET /v1/brands/{brand_id}/seo/keywords/{keyword_id}/history Get a keyword's rank history
  17. GET /v1/brands/{brand_id}/seo/keywords/{keyword_id}/prompts List the AI prompts behind a keyword
  18. GET /v1/brands/{brand_id}/seo/keywords/candidates List keyword candidates
  19. POST /v1/brands/{brand_id}/seo/keywords/metric-refreshes Refresh keyword numbers
  20. POST /v1/brands/{brand_id}/seo/keywords/rank-checks Check Google positions
  21. PATCH /v1/brands/{brand_id}/seo/keywords/tracking Turn rank tracking on or off
  22. GET /v1/brands/{brand_id}/seo/overview Get the Google overview
  23. POST /v1/brands/{brand_id}/seo/overview/refreshes Refresh the Google overview
  24. GET /v1/brands/{brand_id}/seo/prompt-insights Get prompt insights for a report
  25. PUT /v1/brands/{brand_id}/seo/prompt-insights/keyword Pin the keyword a prompt stands for
  26. POST /v1/brands/{brand_id}/seo/prompt-insights/lookups Look up prompt insights
  27. GET /v1/brands/{brand_id}/seo/rank-schedule Get the rank check schedule
  28. PUT /v1/brands/{brand_id}/seo/rank-schedule Set the rank check schedule
  29. POST /v1/brands/{brand_id}/seo/serp-snapshots Read a keyword's Google page

SEO pages

15 endpoints

Track pages and run Lighthouse/PageSpeed audits plus technical SEO crawls on them. Includes Core Web Vitals history and ready-to-paste structured-data templates. Audits cost credits.

  1. GET /v1/brands/{brand_id}/ai-crawlers Read AI crawler activity
  2. GET /v1/brands/{brand_id}/schema-templates Get schema.org templates
  3. GET /v1/brands/{brand_id}/seo-pages List tracked pages
  4. POST /v1/brands/{brand_id}/seo-pages Track a page
  5. GET /v1/brands/{brand_id}/seo-pages/{page_id} Retrieve a tracked page
  6. PATCH /v1/brands/{brand_id}/seo-pages/{page_id} Update a tracked page
  7. DELETE /v1/brands/{brand_id}/seo-pages/{page_id} Stop tracking a page
  8. GET /v1/brands/{brand_id}/seo-pages/{page_id}/audits List page audits
  9. POST /v1/brands/{brand_id}/seo-pages/{page_id}/audits Run a page audit
  10. GET /v1/brands/{brand_id}/seo-pages/{page_id}/audits/{audit_id} Retrieve a page audit
  11. DELETE /v1/brands/{brand_id}/seo-pages/{page_id}/audits/{audit_id} Delete a page audit
  12. GET /v1/brands/{brand_id}/seo-pages/{page_id}/crux-history Retrieve Core Web Vitals trend
  13. GET /v1/brands/{brand_id}/seo-pages/{page_id}/technical-checks Retrieve the latest technical check
  14. POST /v1/brands/{brand_id}/seo-pages/{page_id}/technical-checks Run a technical check
  15. GET /v1/brands/{brand_id}/seo-pages/candidates List pages to track

Tasks

6 endpoints

The brand's action items (content, technical, outreach) created by report AI suggestions and the agent, with status and priority. Deleting a task requires OWNER access.

  1. GET /v1/brands/{brand_id}/tasks List tasks
  2. POST /v1/brands/{brand_id}/tasks Create a task
  3. GET /v1/brands/{brand_id}/tasks/{task_id} Retrieve a task
  4. PATCH /v1/brands/{brand_id}/tasks/{task_id} Update a task
  5. DELETE /v1/brands/{brand_id}/tasks/{task_id} Delete a task
  6. GET /v1/brands/{brand_id}/tasks/summary Task counts summary

Analytics

8 endpoints

Read the brand's Google Analytics 4 / Search Console connection status. Connecting a Google account is done in the app, not the API.

  1. GET /v1/brands/{brand_id}/analytics/ai-traffic Read traffic the answer engines sent
  2. GET /v1/brands/{brand_id}/analytics/connection Get Google connection status
  3. PATCH /v1/brands/{brand_id}/analytics/connection Pick the property and the site
  4. POST /v1/brands/{brand_id}/analytics/connection-links Mint a link that connects Google
  5. GET /v1/brands/{brand_id}/analytics/pages Read one page's performance
  6. GET /v1/brands/{brand_id}/analytics/properties List the Google properties on offer
  7. POST /v1/brands/{brand_id}/analytics/refreshes Pull the brand's Google data again
  8. GET /v1/brands/{brand_id}/analytics/summary Analytics summary

Search Console

3 endpoints

Google Search Console data for a connected brand: submitted sitemaps and URL inspection (indexing status).

  1. GET /v1/brands/{brand_id}/search-console/performance Read Search Console performance
  2. GET /v1/brands/{brand_id}/search-console/sitemaps List submitted sitemaps
  3. GET /v1/brands/{brand_id}/search-console/url-inspection Inspect a URL in Search Console

OpenAI Ads

3 endpoints

Read-only reporting of the brand's OpenAI Ads (paid, labeled placements in ChatGPT): performance, attributed conversions and campaigns. Connecting the ad account is done in the app, not the API.

  1. GET /v1/brands/{brand_id}/openai-ads/campaigns List OpenAI Ads campaigns
  2. GET /v1/brands/{brand_id}/openai-ads/conversions Read OpenAI Ads attributed conversions
  3. GET /v1/brands/{brand_id}/openai-ads/performance Read OpenAI Ads performance

Webhooks

12 endpoints

Register endpoints to receive event notifications (e.g. a report finishing), and inspect recent deliveries.

  1. GET /v1/brands/{brand_id}/webhooks List webhook endpoints
  2. POST /v1/brands/{brand_id}/webhooks Create a webhook endpoint
  3. GET /v1/brands/{brand_id}/webhooks/{webhook_id} Retrieve a webhook endpoint
  4. PATCH /v1/brands/{brand_id}/webhooks/{webhook_id} Update a webhook endpoint
  5. DELETE /v1/brands/{brand_id}/webhooks/{webhook_id} Delete a webhook endpoint
  6. GET /v1/brands/{brand_id}/webhooks/{webhook_id}/deliveries List recent deliveries
  7. POST /v1/brands/{brand_id}/webhooks/{webhook_id}/deliveries/{delivery_id}/replays Replay a delivery
  8. POST /v1/brands/{brand_id}/webhooks/{webhook_id}/secret-rotations Rotate the signing secret
  9. POST /v1/brands/{brand_id}/webhooks/{webhook_id}/test-deliveries Send a test delivery
  10. GET /v1/me/webhooks List account webhooks
  11. POST /v1/me/webhooks Create an account webhook
  12. DELETE /v1/me/webhooks/{webhook_id} Delete an account webhook

Agency

27 endpoints
  1. GET /v1/agency/competitors List the portfolio's competitors
  2. GET /v1/agency/heatmap Read the visibility heatmap
  3. GET /v1/agency/portfolio Read the portfolio
  4. GET /v1/agency/prospect-lists List prospect lists
  5. GET /v1/agency/prospect-lists/{list_id} Retrieve a prospect list
  6. GET /v1/agency/prospect-lists/{list_id}/pipeline Read a prospect list's outreach pipeline
  7. POST /v1/agency/prospect-lists/{list_id}/pipeline-runs Move prospects one stage on
  8. POST /v1/agency/prospect-lists/{list_id}/prospects Save prospects into a list
  9. GET /v1/agency/prospect-report-views List who opened their report
  10. POST /v1/agency/prospect-searches Search for prospects
  11. GET /v1/agency/prospect-suggestions List prospects suggested by the clients' reports
  12. GET /v1/agency/prospecting-overview Read what waits in prospecting
  13. PATCH /v1/agency/prospects/{prospect_id} Update a prospect
  14. POST /v1/agency/prospects/{prospect_id}/contact-lookups Find a prospect's contact
  15. GET /v1/agency/prospects/{prospect_id}/outreach-preview Preview a prospect's outreach
  16. POST /v1/agency/prospects/{prospect_id}/pitch Write a prospect's pitch
  17. POST /v1/agency/prospects/{prospect_id}/reports Run a prospect's AI visibility report
  18. GET /v1/agency/prospects/funnel Read the prospect pipeline
  19. GET /v1/agency/reviews List pending article reviews
  20. GET /v1/agency/saved-prospect-searches List saved prospect searches
  21. POST /v1/agency/saved-prospect-searches Save a prospect search to run every week
  22. PATCH /v1/agency/saved-prospect-searches/{search_id} Pause, resume or retarget a saved prospect search
  23. DELETE /v1/agency/saved-prospect-searches/{search_id} Delete a saved prospect search
  24. GET /v1/agency/saved-prospect-searches/{search_id}/runs List a saved prospect search's runs
  25. GET /v1/agency/tasks List the portfolio's tasks
  26. GET /v1/agency/tasks/summary Count the portfolio's tasks
  27. GET /v1/agency/undated-articles List the undated articles across the portfolio

Client reports

8 endpoints
  1. POST /v1/brands/{brand_id}/client-report-versions/{version_id}/shares Share a client report version
  2. GET /v1/client-reports List client reports
  3. POST /v1/client-reports Create a client report
  4. GET /v1/client-reports/{document_id} Retrieve a client report
  5. PATCH /v1/client-reports/{document_id} Edit a client report
  6. GET /v1/client-reports/{document_id}/facts Read a client report's facts
  7. POST /v1/client-reports/{document_id}/versions Publish a client report
  8. POST /v1/client-reports/versions/{version_id}/deliveries Send a held client report

Community

6 endpoints
  1. POST /v1/brands/{brand_id}/community-searches Search for community threads
  2. GET /v1/brands/{brand_id}/community-threads List community threads
  3. POST /v1/brands/{brand_id}/community-threads Add community threads
  4. PATCH /v1/brands/{brand_id}/community-threads/{thread_id} Update a community thread
  5. PUT /v1/brands/{brand_id}/community-threads/{thread_id}/context Read a community thread
  6. PUT /v1/brands/{brand_id}/community-threads/{thread_id}/draft Draft a community reply

Google Business Profile

11 endpoints
  1. GET /v1/brands/{brand_id}/gbp/locations List Business Profile locations
  2. GET /v1/brands/{brand_id}/gbp/locations/{location_id}/geo-scans List a location's geo-grid scans
  3. POST /v1/brands/{brand_id}/gbp/locations/{location_id}/geo-scans Run a geo-grid scan
  4. GET /v1/brands/{brand_id}/gbp/locations/{location_id}/geo-scans/{scan_id} Retrieve a geo-grid scan
  5. GET /v1/brands/{brand_id}/gbp/locations/{location_id}/performance Read a location's performance
  6. POST /v1/brands/{brand_id}/gbp/locations/{location_id}/post-schedules Schedule a local post
  7. GET /v1/brands/{brand_id}/gbp/locations/{location_id}/profile Read a location's profile
  8. PATCH /v1/brands/{brand_id}/gbp/locations/{location_id}/profile Update a location's profile
  9. GET /v1/brands/{brand_id}/gbp/locations/{location_id}/reviews List a location's reviews
  10. POST /v1/brands/{brand_id}/gbp/locations/{location_id}/reviews/{review_id}/replies Reply to a review
  11. GET /v1/brands/{brand_id}/gbp/post-schedules List scheduled posts

Outreach

49 endpoints
  1. GET /v1/brands/{brand_id}/campaigns List campaigns
  2. POST /v1/brands/{brand_id}/campaigns Create a campaign
  3. GET /v1/brands/{brand_id}/campaigns/{campaign_id} Retrieve a campaign
  4. PATCH /v1/brands/{brand_id}/campaigns/{campaign_id} Update, launch, pause or end a campaign
  5. GET /v1/brands/{brand_id}/campaigns/{campaign_id}/preview Preview a campaign's launch
  6. GET /v1/brands/{brand_id}/campaigns/{campaign_id}/timeline A campaign's days
  7. GET /v1/brands/{brand_id}/contact-lists List contact lists
  8. POST /v1/brands/{brand_id}/contact-lists Create a contact list
  9. GET /v1/brands/{brand_id}/contact-lists/{list_id} Retrieve a contact list
  10. PATCH /v1/brands/{brand_id}/contact-lists/{list_id} Update a contact list
  11. GET /v1/brands/{brand_id}/contact-lists/{list_id}/contacts List a contact list's contacts
  12. POST /v1/brands/{brand_id}/contact-lists/{list_id}/contacts Add contacts to a static list
  13. DELETE /v1/brands/{brand_id}/contact-lists/{list_id}/contacts/{contact_id} Remove a contact from a static list
  14. POST /v1/brands/{brand_id}/contact-lists/previews Preview a dynamic list's filter
  15. GET /v1/brands/{brand_id}/contacts List outreach contacts
  16. POST /v1/brands/{brand_id}/contacts Add an outreach contact
  17. PATCH /v1/brands/{brand_id}/contacts Tag several contacts
  18. GET /v1/brands/{brand_id}/contacts/{contact_id} Retrieve an outreach contact
  19. PATCH /v1/brands/{brand_id}/contacts/{contact_id} Update an outreach contact
  20. GET /v1/brands/{brand_id}/contacts/{contact_id}/citations List the pages a contact was found on
  21. GET /v1/brands/{brand_id}/email-sequences List email sequences
  22. POST /v1/brands/{brand_id}/email-sequences Create an email sequence
  23. GET /v1/brands/{brand_id}/email-sequences/{sequence_id} Retrieve an email sequence
  24. PATCH /v1/brands/{brand_id}/email-sequences/{sequence_id} Update an email sequence
  25. POST /v1/brands/{brand_id}/email-sequences/{sequence_id}/steps/{step_id}/variants Add an A/B variant to a step
  26. GET /v1/brands/{brand_id}/email-sequences/{sequence_id}/variants List a sequence's A/B variants
  27. PATCH /v1/brands/{brand_id}/email-sequences/{sequence_id}/variants/{variant_id} Update an A/B variant
  28. GET /v1/brands/{brand_id}/email-templates List email templates
  29. POST /v1/brands/{brand_id}/email-templates Create an email template
  30. PATCH /v1/brands/{brand_id}/email-templates/{template_id} Update an email template
  31. GET /v1/brands/{brand_id}/emails List outreach emails
  32. POST /v1/brands/{brand_id}/emails Save an outreach email draft
  33. GET /v1/brands/{brand_id}/emails/{email_id} Retrieve an outreach email
  34. PATCH /v1/brands/{brand_id}/emails/{email_id} Update an outreach email
  35. POST /v1/brands/{brand_id}/emails/{email_id}/reply-drafts Draft a reply in a thread
  36. POST /v1/brands/{brand_id}/emails/{email_id}/sends Send an outreach email
  37. GET /v1/brands/{brand_id}/emails/{email_id}/thread Read an email's thread
  38. POST /v1/brands/{brand_id}/emails/ai-compositions Write a pitch with AI
  39. GET /v1/brands/{brand_id}/emails/replies List outreach replies
  40. GET /v1/brands/{brand_id}/emails/summary Outreach email counts
  41. GET /v1/brands/{brand_id}/outreach/authors List the most cited authors
  42. POST /v1/brands/{brand_id}/outreach/citations Add pages to Backlink outreach
  43. PATCH /v1/brands/{brand_id}/outreach/citations/{citation_id} Set a cited page's contact
  44. POST /v1/brands/{brand_id}/outreach/citations/{citation_id}/backlink-verifications Check a cited page for a backlink
  45. POST /v1/brands/{brand_id}/outreach/processing-jobs Analyze cited pages for outreach
  46. POST /v1/me/mailbox-connection-links Mint a link that connects Gmail
  47. GET /v1/me/mailboxes List mailboxes
  48. PATCH /v1/me/mailboxes/{mailbox_id} Update a mailbox
  49. DELETE /v1/me/mailboxes/{mailbox_id} Disconnect a mailbox