# 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…
- [Authentication](https://docs.athenahq.ai/api-reference/authentication.md): Authenticate API requests using API keys
- [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 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.
- [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.
- [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.
- [Rate Limits](https://docs.athenahq.ai/api-reference/rate-limits.md): API rate limits and availability
- [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.

## OpenAPI Specs

- [openapi](https://docs.athenahq.ai/api-reference/openapi.json)