Skip to main content
v1.0GuidesGuidesAPI ReferenceAPI Reference

API Endpoints

Profile360​

Enrich data for one person based on their email address. Returns identity and professional details, company information, visitor journey, ad conversions, and engagement milestones. For multiple profiles in a single request, use the Bulk Profile360 endpoint.

Key data returned​

  • Full name, first name, last name, gender, photo URL
  • Job title, profile creation date, profile type
  • Company details (name, domain, UUID)
  • Visitor IDs and IP addresses
  • Visitor journey and page interactions
  • Milestones achieved with timestamps
  • Ad conversion data with campaign details

Account360​

Retrieve comprehensive account intelligence for a company based on its domain. Aggregates data across multiple dimensions including visitor activity, intent signals, technology stack, and engagement history.

Key data returned​

  • Complete firmographic details (name, description, domain, type, phone, UUID, employees, employee range, annual revenue, estimated revenue range, founded year)
  • Location information (street address, city, postal code, state, country)
  • Industry classification and sub-industry
  • LinkedIn URL
  • Visitor metrics (visitors count, identified people count)
  • Activity log and customer journey with detailed event tracking (timestamps, UTM parameters, attributes, milestones)
  • List of identified people
  • Intent signals and intent trends
  • Sessions duration and total active time
  • Buying stage and lifecycle stage indicators
  • ICP scoring
  • Website visitors and top visited pages
  • Complete technology stack and categories
  • Company tags

Search and filter accounts based on firmographic criteria, engagement signals, and intent data. Combines Sona's flexible search filtering with the rich account intelligence provided by Account360, returning paginated results with full account detail for each match. See the full Account360 Search API reference.

Search parameters​

Supports filtering by the following fields: name, domain, industry, sub-industry, country, city, state, postal code, street address, type, phone, employees, employee range, annual revenue, estimated annual revenue, founded year, LinkedIn, tech stack, tech categories, tags, buying stage, lifecycle stage, ICP score, visitors count, identified people, intent signals, sessions duration, and total active time.

Supported operators​

  • is not empty, is empty
  • contains, does not contain, starts with
  • =, <>, >, <, >=, <=
  • range, in set (exact), in set (phrase)

Key data returned per account​

  • Full Account360 intelligence including firmographic details, location, and industry classification
  • Engagement data (activity log, customer journey, identified people)
  • Intent signals and intent trends
  • Buying stage, lifecycle stage, and ICP scoring
  • Session metrics, website visitors, and top pages
  • Complete technology stack and categories
  • Account tags

Discover and filter companies based on various firmographic criteria. Search through thousands of company records using parameters like domain, name, industry, location, and more. Supports flexible filtering with multiple operators.

Search parameters​

Supports filtering by the following fields: website, name, logo, industry, country, city, state, postal code, LinkedIn URL, tech stack, tech categories, founded year, employee ranges, employees, description, tags, annual revenue, estimated revenue ranges, type, timezone, phone, street address, coordinates, sub-industry, IP addresses, category, sub-category, tagline, specialties, advertising metrics, social media URLs, SEO metrics, founder identifiers, and number of founders.

Supported operators​

  • is not empty, is empty
  • contains, does not contain, starts with
  • =, <>, >, <, >=, <=
  • range, in set (exact), in set (phrase)

Returns paginated results with​

  • Basic information (website, name, founded year, logo, type, description, tagline)
  • Size and revenue metrics (employees, employee range, annual revenue, estimated revenue ranges)
  • Location data (locality, region, country, complete address, coordinates, timezone)
  • Industry classification (industry, sub-industry, category, sub-category, specialties)
  • Complete technology stack and categories
  • All social media URLs (LinkedIn, Facebook, Twitter, Instagram, YouTube, TikTok, Pinterest, GitHub, Discord, Telegram, Reddit, Snapchat, Medium, Twitch)
  • Third-party profiles (Crunchbase, G2)
  • Advertising metrics (LinkedIn ads for 30 days, 365 days, YTD)
  • SEO metrics (organic keywords, traffic, cost)
  • Paid advertising metrics (AdWords keywords, traffic, cost)
  • Contact information (phone, social handles)
  • IP addresses and tags
  • Pagination details (total results, current page, offset)

Company Enrichment​

Enrich data for a single company based on its domain. Returns comprehensive company information including firmographics, technology usage, social profiles, and revenue estimates.

Key data returned​

  • Basic details (name, founded year, type, description, logo, tagline)
  • Contact information (phone, complete address, timezone)
  • Size metrics (employees, employee range, annual revenue, estimated revenue ranges)
  • Location data (street address, city, postal code, state, country, coordinates)
  • Industry classification (industry, sub-industry, category, sub-category, specialties)
  • Complete technology stack with categories
  • All social media URLs (LinkedIn, Facebook, Twitter, Instagram, YouTube, TikTok, Pinterest, GitHub, Discord, Telegram, Reddit, Snapchat, Medium, Twitch, Crunchbase, G2)
  • Social handles
  • LinkedIn advertising metrics (30 days, 365 days, YTD)
  • SEO metrics (organic keywords, traffic, cost)
  • Paid advertising metrics (AdWords keywords, traffic, cost)
  • IP addresses
  • Tags, locality, and region

Retrieve the logo image URL for a specific company. Lightweight endpoint designed for quickly fetching company logos without consuming full enrichment credits.

Returns​

  • Direct URL to company logo hosted on Sona's CDN

Discover professionals working at a specific company. Filter and retrieve detailed employee information based on various professional and demographic criteria. Ideal for building targeted prospecting lists and identifying decision-makers.

Search parameters​

Requires company website domain. Supports optional filtering by: email, first name, last name, full name, tags, job title, gender, photo URL, birth date, LinkedIn URL, Facebook URL, Twitter URL, GitHub URL, work email, personal emails, phone, phone numbers, emails, timezone, city, state, country, continent, street address, postal code, coordinates, skills, and socials.

Supported operators​

  • is not empty, is empty
  • contains, does not contain, starts with
  • =, <>, >, <, >=, <=
  • range, in set (exact), in set (phrase)

Key data returned​

  • Identity information (email, first name, last name, full name, gender, photo URL, birth date)
  • Professional details (job title, creation date, skills)
  • Contact information (work email, personal emails, phone, phone numbers, all emails)
  • Social profiles (LinkedIn URL, Facebook URL, Twitter URL, GitHub URL, social handles)
  • Location data (city, state, country, continent, street address, postal code, coordinates, timezone)
  • Tags (e.g., "buying committee", "location match", "persona match")
  • Total results count

Note on email access​

Email addresses marked as [email protected] require additional credits to unlock full contact information.

AI Visibility​

Retrieve the AI Visibility data tracked for your monitored brands: the prompts asked to AI platforms, the answers they returned, how often your brand and competitors are mentioned, and which sources the answers cite. All AI Visibility endpoints are GET requests and do not consume credits. See the full AI Visibility API reference.

Common parameters​

  • Brand: most endpoints identify the brand by brandDomain (for example, sonalabs.com). Keywords, Platforms, Site Pages, Site Page Audits, Source Domains, and Source URLs also accept brandId from the Brands endpoint. Models, Tags, and Topics require brandId.
  • Date range: startDate and endDate (Y-m-d) are used together. When omitted, the range covers all of the brand's tracked answers.
  • Filters: platform takes comma-separated platform IDs from the Platforms or Models endpoint, and topicId takes comma-separated topic IDs from the Topics endpoint.
  • Pagination: list endpoints support offset and limit (default 25, maximum 100).

Brands​

List the brands monitored in your AI Visibility workspace. See the Brands API reference.

  • Brand ID, name, URL, and logo
  • Country, language, and timezone the brand is monitored for
  • LLM providers the brand is tracked across

Platforms​

List the AI platforms a brand is tracked on, such as ChatGPT, Gemini, and Google AI Overview. Use the returned IDs as the platform filter on other AI Visibility endpoints. See the Platforms API reference.

  • Platform ID and display name for each enabled platform

Prompts​

List a brand's tracked prompts with their AI Visibility metrics. Filter by status, prompt text, platform, topic, and date range, and sort by visibility, position, share of voice, or last run. See the Prompts API reference.

  • Prompt text, status (active, archived, or suggested), buying stage, and intent
  • Parent prompt ID for fan-out prompts
  • Visibility, highest position, and share of voice for your brand
  • When the prompt was last run
  • Topic and brand details

Prompt Rankings​

List individual AI answers (rankings) for a brand, newest first. Filter by prompt text, date range, platform, topic, and whether your brand was mentioned. See the Prompt Rankings API reference.

  • The prompt and the AI platform and model that answered it
  • Your brand's ranking position in the answer
  • The answer output, mentioned brands, and cited sources
  • Location and ranking date

Visibility Over Time​

Track how often your brand appears in AI answers as a daily, weekly, or monthly series. Periods with no answers are returned as zeros, so the series has no gaps. See the Visibility Over Time API reference.

  • Period start date
  • Total answers and answers mentioning your brand
  • Visibility percentage for each period

Visibility by Brand​

Compare the share of AI answers that mention your brand against the competitors found in the same answers. Returns the top 8 brands by mention count. See the Visibility by Brand API reference.

  • Total answers in the range
  • Each brand's name, URL, logo, and whether it is your own brand
  • Mention count and visibility percentage

Brand Rankings​

Rank your brand and its competitors by how often and how well they are mentioned in AI answers. Filter by platform, topic, prompt, or tracked competitors only. See the Brand Rankings API reference.

  • Mention count, visibility, and share of voice
  • Position score (1 = best)
  • Sentiment score, and the score for the previous period of equal length
  • Whether each brand is your own brand or a tracked competitor
  • Brand aliases and domains

Sources by Type​

See which kinds of sites, such as news, reviews, forums, or your own site, AI answers cite for your brand's prompts. Count individual citations, or distinct domains with groupByDomain=true. See the Sources by Type API reference.

  • Total citations in the range
  • Each source type's name, citation count, and share of all citations
  • Up to 7 most-cited domains for each source type

Keywords​

List the search keywords tracked for a brand, with their search metrics and linked prompts. Search by keyword or topic name and sort by any metric. See the Keywords API reference.

  • Keyword, topic, buying stage, and intent
  • Search metrics: volume, position, previous position, difficulty, CPC, and competition
  • Sona scores: opportunity, demand, and winnability
  • The brand page ranking for the keyword
  • Linked prompts and linked prompt count

Chat Detail​

Get one AI chat in full: a single AI platform's answer to one of your prompts, with everything extracted from it. Use the id of a chat returned by Prompt Rankings. See the Chat Detail API reference.

  • The full answer as the AI platform gave it, in markdown
  • Structured data extracted from the answer: brands (with overview, pros, cons, pricing, and sentiment), sources, topics, and summary
  • The brands the answer mentions by position, and the brands and competitors matched in the answer
  • The pages the answer cited, with their source type and the brand each one belongs to
  • Your brand's ranking position, whether it was mentioned, and the prompt, location, language, platform, and ranking date

Models​

List the AI models your brand's prompts run on, one row per AI platform enabled for the brand. See the Models API reference.

  • Platform ID and display name. Use the ID as the platform filter on other AI Visibility endpoints
  • The model the platform currently runs on, or null when the platform doesn't expose one (for example, Google AI Overview)

Site Pages​

List the pages of your brand's own website, with how AI crawlers and AI platforms interact with them. See the Site Pages API reference.

  • Visits by AI crawlers, visitors referred by AI platforms, total and traditional referrals, and bot referral percentage over the date range
  • Technical audit score (0-100) and the latest audit suggestions
  • Search demand for the page: search volume, traffic percentage, CPC, and keywords by intent
  • Up to 10 tracked keywords the page is the content for
  • Whether the page is watched (audited and analyzed by Sona)

Site Page Audits​

List the technical audit runs of one page of your brand's website, newest first. Identify the page by pageId or pageUrl. See the Site Page Audits API reference.

  • Score (0-100), grade (A-F), and grade label for each run
  • Change against the previous completed run
  • Failed checks (critical and warning counts) out of the total checks run
  • Run status: queued, running, completed, failed, or cancelled
  • Score breakdown: content accessibility (35%), meta quality (25%), structured data (20%), and performance (20%)
  • Page load time in milliseconds during the run

Source Domains​

List the domains AI answers cite as sources for your brand's prompts, one row per domain. See the Source Domains API reference.

  • Percentage of the brand's chats that cited the domain at least once, and its citation rate
  • Whether the domain's cited pages also mention your brand
  • The kind of site the domain is, such as Editorial or Corporate

Source URLs​

List the pages AI answers cite as sources for your brand's prompts, one row per cited URL. See the Source URLs API reference.

  • Percentage of the brand's chats that cited the URL, and its citation rate
  • Whether the page also mentions your brand, and which brands and competitors it mentions
  • The kind of site the page is on, such as Editorial or Corporate

Tags​

List the tags used on your brand's prompts, such as Branded or Informational. See the Tags API reference.

  • Tags on at least one of the brand's active prompts, sorted by name
  • Number of the brand's active prompts carrying each tag

Topics​

List the AI Visibility topics your brand's prompts are organized in. Use a topic ID as the topicId filter on other AI Visibility endpoints. See the Topics API reference.

  • Number of active prompts and tracked search keywords in the topic
  • Google search demand for the topic: average monthly searches, competition level, and competition index (0-100), or null when not measured
  • The country the topic's prompts run for, or null when the topic uses the brand's default

Marketing Measurement​

Retrieve your organization's marketing mix models: how much each marketing channel drives a KPI, its ROI, where spend starts to saturate, and the budget scenarios planned in Scenario Planner. This is the same data as Revenue & Marketing Attribution → Forecast & Plan in the Sona app. All Marketing Measurement endpoints are read-only GET requests and do not consume credits. See the full Marketing Measurement API reference.

KPIs​

List the KPIs your organization models. See the KPIs API reference.

  • KPI name, as used by the kpi parameter of the other endpoints
  • Whether the KPI is still selected in Settings → Marketing Measurement
  • The KPI's latest model: ID, status (pending, running, complete, or failed), error for a failed fit, and dates

Model Results​

Get the latest marketing mix model for one KPI (kpi, default Revenue). Only complete models have results; a KPI with no model returns 404. See the Model Results API reference.

  • Model summary and fit metrics (R², MAPE, wMAPE)
  • Per channel: incremental KPI, % of contribution, spend, ROI, marginal ROI, and CPIK, with 90% credible intervals
  • Baseline versus channel contribution
  • Response curves for each paid channel at 0× to 2× its actual spend
  • Daily model fit (actual, expected, and baseline KPI) and model input (KPI, spend, and organic activity)

Scenarios​

List Scenario Planner runs, newest first, without their results. Filter by kpi and status, and page with offset and limit. See the Scenarios API reference.

  • Scenario ID, KPI, status, and created date
  • What the scenario changed: shifts (monthly amounts moved between paid channels, in manual mode) or allocations (new monthly spend per paid channel, in auto mode)
  • Planner settings: mode, fixed budget or flexible target, and per-channel bounds

Scenario Results​

Get one scenario's results by scenarioId, in the same shape as Model Results, plus the scenario it was created with. A scenario is a refit of the model with spend changed, so compare it with Model Results for the same KPI. See the Scenario Results API reference.

Last updated on by Sona