# AthenaHQ ## Docs - [AI Access](https://docs.athenahq.ai/api-reference/ai-access.md): Programmatically check whether major AI answer engines can crawl a public domain. - [Check AI accessibility for a domain](https://docs.athenahq.ai/api-reference/ai-access/check-ai-accessibility-for-a-domain.md): Probe a public domain to determine whether the major AI answer engines (ChatGPT, Claude, Perplexity, Gemini, Copilot, Grok, DeepSeek, Rufus) can crawl it. Returns the same per-model HTTP / robots.txt verdicts the AthenaHQ web app surfaces in its AI accessibility dialog, plus a plain-text diagnostic… - [AI Search Value](https://docs.athenahq.ai/api-reference/ai-search-value.md): Read the estimated monthly dollar value of a website's presence in AI search answers, as a range grounded in Google keyword economics. - [AI Search Value for a website: topic-market value, captured value range, headroom, coverage, value-weighted AI share of voice, per-topic detail, and modeled attributed contribution.](https://docs.athenahq.ai/api-reference/ai-search-value/ai-search-value-for-a-website:-topic-market-value-captured-value-range-headroom-coverage-value-weighted-ai-share-of-voice-per-topic-detail-and-modeled-attributed-contribution.md): AI Search Value for a website: topic-market value, captured value range, headroom, coverage, value-weighted AI share of voice, per-topic detail, and modeled attributed contribution. - [Authentication](https://docs.athenahq.ai/api-reference/authentication.md): Authenticate API requests using API keys - [Create Location](https://docs.athenahq.ai/api-reference/basics/create-location.md): Creates a location for a website. `country` is case-insensitive and stored as its canonical label. Any attached `prompt_ids` must allow the location's country. - [Create Prompts](https://docs.athenahq.ai/api-reference/basics/create-prompts.md): Creates one or more prompts on a website. Returns the created prompt ids. Each prompt's geography (`countries` / `primary_country`) and any attached `location_ids` are validated for compatibility before insert. - [Create Website](https://docs.athenahq.ai/api-reference/basics/create-website.md): Creates a new website in your organization. The website will be created with onboarding step 1, ready for further configuration. **Partner integrations** may include an `external_id` to map their own identifier onto the new Athena website. - [Delete Location](https://docs.athenahq.ai/api-reference/basics/delete-location.md): Soft-deletes a location. - [Delete Prompt](https://docs.athenahq.ai/api-reference/basics/delete-prompt.md): Deletes a prompt. Soft-deletes when the prompt already has responses, otherwise hard-deletes. - [Delete Website](https://docs.athenahq.ai/api-reference/basics/delete-website.md): Deletes a website. Removes it from your organization and stops all associated processing. Requires a global API key. Idempotent: re-calling on an already deleted website returns 200. This action is reversible — call `POST /api/v1/websites/{website_id}/restore` to reactivate a deleted website. - [Get Competitors](https://docs.athenahq.ai/api-reference/basics/get-competitors.md): Returns all competitors for a specific website. - [Get Date Range](https://docs.athenahq.ai/api-reference/basics/get-date-range.md): Returns the date range with available data for a website's prompts. Use this to determine the valid date range for other API queries. - [Get Group Saved Views](https://docs.athenahq.ai/api-reference/basics/get-group-saved-views.md): Returns all group-level saved views (filter presets) for the websites in a group. Group saved views capture filter state shared across the group rather than scoped to a single website. - [Get Locations](https://docs.athenahq.ai/api-reference/basics/get-locations.md): Returns all locations for a specific website. - [Get Prompts](https://docs.athenahq.ai/api-reference/basics/get-prompts.md): Returns all prompts for a specific website. You can optionally filter by status (active or paused). The prompts returned include metadata such as monthly search volume and total value. - [Get Saved Views](https://docs.athenahq.ai/api-reference/basics/get-saved-views.md): Returns all saved views (filter presets) for a specific website. Each saved view captures a named set of filters that can be reused across the dashboard. - [Get Websites](https://docs.athenahq.ai/api-reference/basics/get-websites.md): Returns all active websites associated with your API key. **Partner integrations** may pass `external_id` as a query parameter to find the Athena website mapped to a partner-supplied identifier. - [Pause or Unpause Prompts](https://docs.athenahq.ai/api-reference/basics/pause-or-unpause-prompts.md): Pauses or unpauses multiple prompts in one transaction. - [Provision Website](https://docs.athenahq.ai/api-reference/basics/provision-website.md): Creates a fully configured website in a single call, skipping the onboarding wizard. Optionally configures competitors, prompts, and a processing schedule. Requires a global API key. **Partner integrations** may include an `external_id` to map their own identifier onto the new Athena website. - [Query Responses](https://docs.athenahq.ai/api-reference/basics/query-responses.md): Returns paginated AI model responses for a website with optional filtering by date range, models, prompts, and competitors. - [Restore Website](https://docs.athenahq.ai/api-reference/basics/restore-website.md): Restores a previously deleted website, reactivating processing and making it available again. All historical data is preserved. Requires a global API key. Idempotent: re-calling on an already active website returns 200. - [Update Location](https://docs.athenahq.ai/api-reference/basics/update-location.md): Updates a location's name, country, and/or prompt associations. Only supplied fields change; omitting `prompt_ids` preserves existing associations. Returns a before/after snapshot. - [Update Prompt](https://docs.athenahq.ai/api-reference/basics/update-prompt.md): Updates a prompt's metadata (text, type, volume, topic, geography, locations). Only the supplied fields change. Returns a before/after snapshot. - [Validate API Key](https://docs.athenahq.ai/api-reference/basics/validate-api-key.md): Validates an API key. - [Cancel Subscription](https://docs.athenahq.ai/api-reference/billing/cancel-subscription.md): Cancels a subscription for a specific website. The subscription will remain active until the end of the current billing period. - [Get Group Credits](https://docs.athenahq.ai/api-reference/billing/get-group-credits.md): Returns the current credit balance for a specific group. Requires a global API key. - [Get Organization Credits](https://docs.athenahq.ai/api-reference/billing/get-organization-credits.md): Returns the current credit balance for your organization. - [Get Website Credits](https://docs.athenahq.ai/api-reference/billing/get-website-credits.md): Returns the current credit balance for a specific website. - [Get Website Subscription](https://docs.athenahq.ai/api-reference/billing/get-website-subscription.md): Returns the subscription products for a specific website, including their status and billing dates. - [Changelog](https://docs.athenahq.ai/api-reference/changelog.md): Latest updates and changes to the AthenaHQ API - [List Content Hub Sheets](https://docs.athenahq.ai/api-reference/content/list-content-hub-sheets.md): Returns the Content Hub tabs configured for a website. Each tab is either a `sheet` (content pinned via `content.sheet_id`) or a `view` (saved filter layout over the main content pool). Call this first to discover the `sheet_id`s you can pass to `POST /api/v1/content`. - [List Tracked Content](https://docs.athenahq.ai/api-reference/content/list-tracked-content.md): Returns paginated tracked content with citation, impression, and response metrics joined for the requested date range. Hidden content (`is_hidden = true`) is excluded. - [Per-Content Prompt Citation Breakdown](https://docs.athenahq.ai/api-reference/content/per-content-prompt-citation-breakdown.md): For a single tracked content item, returns every prompt whose AI responses cite the URL — with citations, citation %, and estimated impressions for the date range. - [Create Group](https://docs.athenahq.ai/api-reference/groups/create-group.md): Creates a new group with associated websites. Requires a global API key. **Partner integrations** may include an `external_id` to map their own identifier onto the new Athena group. - [Get Group](https://docs.athenahq.ai/api-reference/groups/get-group.md): Returns a single group by ID, including associated websites. Requires a global API key. **Partner integrations** additionally receive an `externalId` field populated from the partner mapping (if any). - [List Groups](https://docs.athenahq.ai/api-reference/groups/list-groups.md): Returns all groups for your organization, including associated websites. Requires a global API key. **Partner integrations** may pass `external_id` as a query parameter to find the Athena group mapped to a partner-supplied identifier. - [Update Group](https://docs.athenahq.ai/api-reference/groups/update-group.md): Updates a group's name, adds websites, removes websites, and/or (partners only) sets or clears the `external_id` mapping. At least one field must be provided. Requires a global API key. **Partner integrations** may pass `external_id` as a non-empty string to set/replace the mapping, or as `null` to… - [Introduction](https://docs.athenahq.ai/api-reference/introduction.md): Programmatically interact and integrate with AthenaHQ - [Looker Studio](https://docs.athenahq.ai/api-reference/looker-studio.md): Integrate AthenaHQ with Looker Studio - [Citation Rate Over Time](https://docs.athenahq.ai/api-reference/metrics/citation-rate-over-time.md): Returns daily citation rate breakdown over the specified date range. Each entry contains the date and citation rate percentages for your brand and competitors. - [Cumulative Citation Rate](https://docs.athenahq.ai/api-reference/metrics/cumulative-citation-rate.md): Returns citation rate percentages across the specified date range. Shows the percentage of AI responses that cite your brand and competitors as sources. - [Cumulative Mention Rate](https://docs.athenahq.ai/api-reference/metrics/cumulative-mention-rate.md): Returns absolute mention rate percentages across the specified date range. Shows the percentage of AI responses that mention your brand and competitors. - [Cumulative Position](https://docs.athenahq.ai/api-reference/metrics/cumulative-position.md): Returns average position/ranking across the specified date range. Shows where your brand and competitors typically appear in AI responses. - [Cumulative Share of Voice](https://docs.athenahq.ai/api-reference/metrics/cumulative-share-of-voice.md): Returns aggregated share of voice percentages across the specified date range. Shows what percentage of AI responses mention your brand versus competitors. - [Mention Rate Over Time](https://docs.athenahq.ai/api-reference/metrics/mention-rate-over-time.md): Returns daily absolute mention rate breakdown over the specified date range. Each entry contains the date and mention rate percentages for your brand and competitors. - [Position Over Time](https://docs.athenahq.ai/api-reference/metrics/position-over-time.md): Returns daily position/ranking breakdown over the specified date range. Each entry contains position metrics for your brand and competitors. - [Share of Voice Over Time](https://docs.athenahq.ai/api-reference/metrics/share-of-voice-over-time.md): Returns daily share of voice breakdown over the specified date range. Each entry contains the date and SOV percentages for your brand and competitors. - [Get Pitch Report](https://docs.athenahq.ai/api-reference/pitch-workspace/get-pitch-report.md): Returns a single pitch report by ID, including the company metadata, generated prompts, tracked competitors, brand and competitor attributes, top citing sources, and aggregate metrics (brand mentions, sentiment, response rate). - [List Pitches](https://docs.athenahq.ai/api-reference/pitch-workspace/list-pitches.md): Returns all non-deleted pitch workspace reports for the calling organization, ordered by creation date (newest first). Pitches are org-level resources and are not scoped to a single website. - [Power BI & Microsoft Fabric](https://docs.athenahq.ai/api-reference/powerbi-fabric.md): Pull AthenaHQ data into Power BI Desktop, Power BI Service, or Microsoft Fabric via the REST API - [Rate Limits](https://docs.athenahq.ai/api-reference/rate-limits.md): API rate limits and availability - [List Source Pages (per URL)](https://docs.athenahq.ai/api-reference/sources/list-source-pages-per-url.md): Returns individual cited URLs for a website with citation, mention, and impression metrics — one row per `normalized_url`. Each row also includes a `daily_mentions` sparkline (citation percentage per day across the date range) and the same source-type classification as [POST /api/v1/sources](/api-re… - [List Sources (by root domain)](https://docs.athenahq.ai/api-reference/sources/list-sources-by-root-domain.md): Returns the top cited sources for a website, grouped by root domain. Each row carries citation, mention, brand-mention, and impression metrics for the requested date range, plus a `default_source_type` classification (`owned` / `competitor` / `partner` / `third_party`). - [Single Sign-On (SSO)](https://docs.athenahq.ai/api-reference/sso.md): Configure SAML or OIDC single sign-on for your AthenaHQ organization - [Bulk Invite to Websites or Groups](https://docs.athenahq.ai/api-reference/team-management/bulk-invite-to-websites-or-groups.md): Invites a user to multiple websites OR multiple groups in a single request. Provide exactly one of `website_ids` or `group_ids` — the two are mutually exclusive. Each target is processed independently, so some may succeed while others fail (e.g., if the user is already a member). In 'email' mode a s… - [Create Invite](https://docs.athenahq.ai/api-reference/team-management/create-invite.md): Invites a user to your organization, a specific website, or a group. Use `invite_method: "direct"` to add the user immediately without sending any email — if the email has no existing account, a new user account is created automatically. Use `invite_method: "email"` to create a pending invite and se… - [List Group Members](https://docs.athenahq.ai/api-reference/team-management/list-group-members.md): Returns all users with access to a group. By default, the response merges **organization members** (implicit access to every group in the org) and users with explicit **group-member rows**, tagging each entry with an `access_type` field (`organization` or `group`). If a user has both an org membersh… - [List Organization Members](https://docs.athenahq.ai/api-reference/team-management/list-organization-members.md): Returns all members of your organization, including user details (email, first/last name) and their organization role. Requires a global API key. - [List User Websites](https://docs.athenahq.ai/api-reference/team-management/list-user-websites.md): Returns the websites that a user has access to within your organization, either via organization membership (implicit access to all websites in the org) or via explicit website membership. Organization membership takes precedence — if the user is an org member, all non-paused websites in your organi… - [List Website Members](https://docs.athenahq.ai/api-reference/team-management/list-website-members.md): Returns all users with access to a website — both organization members (implicit access to every website in the org) and users with explicit website-member rows. Each entry includes an `access_type` field (`organization` or `website`) so you can tell them apart. If a user has both an org membership… - [Remove Organization Member](https://docs.athenahq.ai/api-reference/team-management/remove-organization-member.md): Removes a user from your organization. Also cleans up any stray website_members rows for that user across all websites in the organization within a single transaction. Requires a global API key. Cannot remove the API key's owning user, the organization owner, or the last remaining admin. - [Remove Website Member](https://docs.athenahq.ai/api-reference/team-management/remove-website-member.md): Removes a user's explicit membership from a website. Accepts a global API key, or a website-scoped key if the website is included in the key's allowlist. Cannot be used to remove the API key's owning user or the organization owner. - [Revoke Organization Invite](https://docs.athenahq.ai/api-reference/team-management/revoke-organization-invite.md): Soft-revokes a **pending** organization invite by setting its status to `revoked`. The invite row is preserved for audit purposes. Returns 409 if the invite is in any other state (already accepted, declined, expired, or revoked), since revoking an accepted invite would leave a misleading audit trail… - [Revoke Website Invite](https://docs.athenahq.ai/api-reference/team-management/revoke-website-invite.md): Soft-revokes a **pending** website invite by setting its status to `revoked`. Accepts a global API key, or a website-scoped key if the invite's target website is included in the key's allowlist. Returns 409 if the invite is in any other state. To remove an already-accepted member, use `DELETE /api/v… - [Update Organization Member Role](https://docs.athenahq.ai/api-reference/team-management/update-organization-member-role.md): Updates an organization member's role. Requires a global API key. Cannot modify the API key's owning user or the organization owner. Cannot demote the last remaining admin. - [Update Website Member Role](https://docs.athenahq.ai/api-reference/team-management/update-website-member-role.md): Updates a website member's role. Accepts a global API key, or a website-scoped key if the website is included in the key's allowlist. Cannot be used to modify the API key's owning user or the organization owner. - [Brand Profile](https://docs.athenahq.ai/brand-profile.md): Set up the brand details Athena uses for tracking, scoring, and content generation - [Getting Started](https://docs.athenahq.ai/getting-started/setup.md): Set up AthenaHQ and start tracking your brand across AI search - [Add Website / Onboarding Setup](https://docs.athenahq.ai/guides/add-website.md): Guides new and existing users through a multi-step wizard to configure a new website for AI visibility tracking, including brand profile, competitors, prompts, Google Search Console, and run schedule. - [Brand Profile](https://docs.athenahq.ai/guides/brand-profile.md): Centralize and manage all brand identity settings, including general info, attributes, brand kits, writing rules, and technical SEO tools, so Athena can accurately represent and optimize the brand across AI search. - [Competitors](https://docs.athenahq.ai/guides/competitors.md): Manage the tracked competitors, discovered competitor suggestions, and deleted competitors for the selected website, including their identifiers and domains used for AI mention detection. - [Content Hub](https://docs.athenahq.ai/guides/content.md): Central workspace where customers manage, create, track, and analyze all their AI-optimized content across sheets, views, and a calendar. - [Social Sources](https://docs.athenahq.ai/guides/content-social.md): Show all social media platform URLs that have cited the user's brand in AI-generated responses, with filtering by platform and standard source analytics. - [Create Pitch Report](https://docs.athenahq.ai/guides/create-pitch.md): Guides agency users through a two-step wizard to generate a new AI-visibility pitch report for a prospect website, including automated website analysis, competitor discovery, and prompt generation. - [Glossary](https://docs.athenahq.ai/guides/glossary.md): Provides customers with definitions and explanations of key AthenaHQ metrics, formulas, and features in an accordion-style reference page. - [Group Dashboard](https://docs.athenahq.ai/guides/group-id.md): Displays aggregated AI visibility metrics (share of voice, mention rate, citation rate, position, dollar value captured) across all websites in a named group, with cross-website filtering and comparison period support. - [Group Billing](https://docs.athenahq.ai/guides/group-id-billing.md): Allows group admins to enable billing for a group, view shared credit balances, purchase additional credits, and review past invoices for the group. - [Competitor Heatmap](https://docs.athenahq.ai/guides/heatmap.md): Visualize how your brand and each tracked competitor perform across topics by Mention % or Citation %, so you can spot gaps and strengths at a glance. - [Home (Ask Athena Chat Homepage)](https://docs.athenahq.ai/guides/home.md): Provides a centered chat composer and quick-prompt suggestions so users can immediately ask Athena AI anything about their brand's AI search presence. - [Insights](https://docs.athenahq.ai/guides/insights.md): Surfaces AI-generated weekly insights and content opportunities so users can take prioritized actions to improve their brand's AI search visibility. - [Knowledge Base](https://docs.athenahq.ai/guides/knowledge-base.md): Lets users build and manage a structured fact bank of claims organized into content pillars, sourced from URLs, documents, text, or Content Hub articles, to power AI fact verification. - [Knowledge Base Pillar Detail](https://docs.athenahq.ai/guides/knowledge-base-pillarId.md): Lets users view and manage a single knowledge base pillar (topic), including its claims, associated site pages, generated document, and matching articles. - [Review Pending Claims](https://docs.athenahq.ai/guides/knowledge-base-review.md): Let users approve or reject AI-extracted knowledge base claims before they count toward published pillars. - [Olympus Dashboard](https://docs.athenahq.ai/guides/olympus.md): Provides a customizable, modular AI search analytics dashboard showing brand visibility, share of voice, citation rates, competitor comparisons, and business value metrics for the active website. - [Oracle](https://docs.athenahq.ai/guides/oracle.md): Analyzes AI model responses to detect and help resolve inaccuracies (discrepancies) about the user's brand, and verifies Knowledge Base facts against external sources. - [Outreach](https://docs.athenahq.ai/guides/outreach.md): Help users discover AI-cited URLs to contact for content placement and track the outreach pipeline from opportunity to completion. - [Pitch Workspace](https://docs.athenahq.ai/guides/pitch-workspace.md): Display the AI search performance report for the currently active pitch, automatically redirecting to pitch creation if no pitches exist. - [Pitch Setup](https://docs.athenahq.ai/guides/pitch-workspace-setup.md): Display a read-only summary of the current pitch's configuration, including basic information, identifiers, competitors, and prompts. - [Pitch Created – Processing](https://docs.athenahq.ai/guides/pitch-workspace-success.md): Inform the user that their newly created pitch report is being processed and automatically redirect them to the Pitch Workspace once it is ready. - [Pitch Workspace Usage](https://docs.athenahq.ai/guides/pitch-workspace-usage.md): Shows the organization's Pitch Report quota consumption: how many pitches have been used and how many remain, so users can track their plan limits. - [Prompts](https://docs.athenahq.ai/guides/prompts.md): Central hub for managing the AI prompts tracked for a website, organized by topic, with per-prompt performance metrics and access to Personas, Locations, Planner, and Universe sub-tabs. - [New Prompt Planner – Cohort Detail](https://docs.athenahq.ai/guides/prompts-new-prompt-planner-id.md): Shows the discovered prompts for a single New Prompt Planner run (cohort), lets users review them by topic, filter/sort, and start tracking selected ones. - [Prompt Universe Run Detail](https://docs.athenahq.ai/guides/prompts-prompt-universe-id.md): Show the detailed results of a single Prompt Universe analysis run, letting users browse AI-discovered prompts grouped by topic, filter and sort them, and start tracking selected prompts. - [Prompt Detail](https://docs.athenahq.ai/guides/prompts-promptId.md): Show all AI model responses collected for a single tracked prompt, with filtering, sorting, and export capabilities. - [Recommendations](https://docs.athenahq.ai/guides/recommendations.md): Surfaces actionable on-page and off-page recommendations to help customers improve their AI Search visibility. - [AI Search Preview Report (Public)](https://docs.athenahq.ai/guides/report-pitchId.md): Publicly shareable, read-only report showing a company's AI search performance: brand mentions, share of voice, competitor analysis, model performance, brand traits, citation sources, and raw AI responses: generated from a pitch/audit run. - [Report Builder](https://docs.athenahq.ai/guides/reports-id.md): Lets users edit the charts, filters, and settings for a specific scheduled report, then send it immediately or let it deliver on its configured schedule. - [Responses](https://docs.athenahq.ai/guides/responses.md): Show every AI model response collected across all tracked prompts so users can review what AI engines say, whether their brand is mentioned, which competitors appear, and which sources are cited. - [Activity Log](https://docs.athenahq.ai/guides/settings-activity.md): Provides an audit trail of every action taken in the organization, with filtering, infinite scroll, and CSV export. - [API & Embed Settings](https://docs.athenahq.ai/guides/settings-api.md): Lets users manage API keys for programmatic access and configure embed tokens/domains for iframing the AthenaHQ dashboard into external sites. - [Billing Settings](https://docs.athenahq.ai/guides/settings-billing.md): Lets customers view their current subscription plan, manage credits, access the billing portal, and review invoice history. - [General Settings](https://docs.athenahq.ai/guides/settings-general.md): Lets organization admins view and manage organization-level details, allowed email domains, SSO configuration, SCIM provisioning, and destructive organization actions. - [Integrations Settings](https://docs.athenahq.ai/guides/settings-integrations.md): Let users connect and manage third-party analytics, CMS, reporting, and Slack integrations for their active website. - [Profile Settings](https://docs.athenahq.ai/guides/settings-profile.md): Lets a signed-in user view and update their personal information, profile picture, sidebar layout preset, and permanently delete their account. - [Users & Access Settings](https://docs.athenahq.ai/guides/settings-users.md): Manage who has access to the organization, its websites, and groups: invite new members, view and edit existing members, and control roles and access levels. - [Shopping Insights](https://docs.athenahq.ai/guides/shopping.md): Shows how your products appear in AI Shopping results, tracking visibility, position, and competitor comparisons. - [Sources](https://docs.athenahq.ai/guides/sources.md): Show every domain and URL that AI models have cited in responses, so users can understand which sources influence their brand's AI visibility. - [Source Analytics](https://docs.athenahq.ai/guides/sources-analytics-source_url.md): Show detailed citation analytics, response data, and URL parameter breakdowns for a specific source URL. - [Source Domain Analytics](https://docs.athenahq.ai/guides/sources-root_domain.md): Show citation performance, URL breakdown, prompt breakdown, and (for YouTube) creator and timestamp insights for a single source domain. - [Sources Visualization](https://docs.athenahq.ai/guides/sources-visualization.md): Display a Sankey flow chart showing which source domains are correlated with LLM mentions of the user's brand and tracked competitors, so users can understand citation attribution. - [Integrations](https://docs.athenahq.ai/integrations.md): Connect analytics, CMS, dashboarding, and reporting tools to Athena - [Knowledge Base](https://docs.athenahq.ai/knowledge-base.md): Give Athena verified facts about your business for accurate research and content generation - [Oracle](https://docs.athenahq.ai/oracle.md): Find and fix inaccurate AI search statements about your brand - [Prompt Universe](https://docs.athenahq.ai/prompt-universe.md): Discover prompts your market uses and find gaps your brand is not covering yet - [Setting Up Your Prompts](https://docs.athenahq.ai/setting-up-prompts.md): Build a useful Athena prompt set with direct entry, planner workflows, or Prompt Universe - [Sources](https://docs.athenahq.ai/sources.md): See which websites AI search engines cite across your tracked prompts ## OpenAPI Specs - [openapi](https://docs.athenahq.ai/api-reference/openapi.json)