AirOps

Campaign ID.

Opportunity IDs to accept. Required for v2; for v1 this accepts every pending item in each opportunity.

V1-only opportunity item IDs to accept. Use this for item-level acceptance.

The Brand Kit ID to add the region to.

ISO 3166-1 alpha-2 country code (e.g. "US", "GB", "JP"). Must be one of the platform-supported codes.

If true, also assigns this region to every existing live prompt in the Brand Kit (subject to the workspace answers limit). Defaults to false.

The data type for the column.

The grid ID. Get it from list_grids.

The grid table (sheet) ID. Get it from list_grids with includes=["grid_tables.grid_columns"]. Every mapped column must belong to this table.

The column title.

Playbook or workflow input mappings keyed by active-version input name. Playbook mapping types are column, value, and brandkit. Workflow mapping types are column, value, brandkit, and knowledge_base. Every mapping requires type and value. For example, map a normal grid column with {"type":"column","value":123}. If column 123 is a playbook column, select one of its active-version artifacts with {"type":"column","value":123,"artifact_name":"Final Article"}.

Required when data_type is playbook. The playbook must have an active published version.

Optional column position. If omitted, appended at the end.

Required when data_type is app_execution. The workflow must belong to the grid workspace and have an active published version.

The Brand Kit ID to query analytics for

Metrics to calculate. Options: mention_rate (brand mention frequency, 0-100), positive_answer_rate (percentage of answers where your brand is positively mentioned, out of all answers where you have been mentioned and sentiment is determined; null when unavailable), share_of_voice (percentage of total mentions, 0-100), citation_rate (citation frequency, 0-100), citation_share (relative citation volume, 0-100), citation_count (total citations), sentiment_score (0-100, negative to positive; null when unavailable), average_position (ranking placement), answer_count (total responses), first_mention_rate (first position frequency, 0-100)

Type of chart to render. Line for time series, bar for comparisons, pie for proportions, area for comparison and visualizing totals with filled area under the curve. Default: line.

Filter by country codes (ISO 3166-1 alpha-2)

Dimensions to group by (max 3).

End date (YYYY-MM-DD). Defaults to yesterday. Must be before today because today's data may still be processing and is incomplete — yesterday is used to ensure robust, complete data. Leave blank unless a specific date is requested.

Time granularity for aggregation. Default: total

Filter by persona IDs

Filter by AI providers

Start date (YYYY-MM-DD). Default: 7 days ago

Filter by tags. A bare array of tag IDs matches ANY (IN). An object {"operator":"IN"|"HAS_ALL"|"NOT_IN","value":[ids]} selects the operator; HAS_ALL matches only items tagged with every listed tag; NOT_IN matches only items tagged with none of the listed tags.

Filter sentiment data by theme IDs. Only applies to sentiment_score metric.

Optional chart title. If not provided, a title will be auto-generated.

Filter by topic IDs

A detailed description of the issue, including: what the user was trying to accomplish, which tools were attempted, what errors occurred (if any), and any suggestions for improvement.

Optional. The brand kit ID relevant to the issue, if applicable.

Optional. Additional context that may help debug the issue. Examples: tool_name, error_messages, attempted_parameters, error_count.

Optional. The workspace ID relevant to the issue, if applicable.

The Brand Kit ID that owns the prompts and tags.

Tag operation to apply to every listed prompt.

AEO prompt (question) IDs to operate on. All must belong to the Brand Kit and not be discarded.

Tag IDs to add or remove. Must exist on the Brand Kit. Use `list_tags` to discover available tag_ids.

The Brand Kit ID that owns the prompts and topic.

AEO prompt (question) IDs to reassign. Unknown or discarded IDs are skipped.

Destination topic ID. Must exist on the Brand Kit. Use `list_topics` to discover available topic_ids. Does NOT create topics — use `create_topic` first if needed.

The Brand Kit ID whose draft should be committed.

The Brand Kit ID to add the persona to.

A description of the persona's perspective and concerns (max 5000 characters). Avoid including specific brand names.

The persona title (max 200 characters). Must be unique within the Brand Kit. Example: "Enterprise CTO".

If true, also assigns this persona to every existing live prompt in the Brand Kit (subject to the workspace answers limit). Defaults to false.

The Brand Kit ID to add the prompt to

The prompt text (max 512 characters). Must be unique within the Brand Kit.

Topic ID to associate with the prompt. Must belong to the same Brand Kit. Use `list_topics` to discover available topics and either suggest one or ask the user to choose.

ISO alpha-2 country codes to assign (e.g., ["US", "GB"]). Must be configured on the Brand Kit.

Whether to track the persona-less default baseline answer (default: true). Set false to skip the generic baseline; at least one named persona is then required.

Persona IDs to assign. Must belong to the same Brand Kit. Use `list_personas` to discover available personas.

Platforms to assign. Valid values: chat_gpt, gemini, perplexity, google_ai_mode, google_ai_overview.

The Brand Kit ID to add the tag to.

The tag name. Must be unique within the Brand Kit (case-insensitive).

Optional. Named color from the platform palette. If omitted, a color is auto-assigned.

The Brand Kit ID this file is intended for

Size of the file in bytes

Base64-encoded MD5 digest of the file contents

MIME type of the file

The filename including extension, e.g. "logo.png" or "brand-font.woff2"

The Brand Kit ID

One-line summary of what changed (max 200 characters)

Markdown detail with the evidence behind the changes, e.g. quotes, source URLs, pages (max 4000 characters)

The name for the new grid.

Optional workspace ID. Defaults to the user's only workspace when unambiguous.

The ID of the grid to add the sheet to.

The name for the new sheet.

Opportunity description.

Opportunity name.

Ordered supporting resources for v2 campaigns. Reddit Thread Creation accepts Brand Kit prompts and pages, not existing threads. YouTube Engagement requires every candidate video and prompt. Rejected for v1 campaigns.

Citation window end date (ISO 8601). Must match candidate discovery.

YouTube metric filters used during candidate discovery.

YouTube video formats used during candidate discovery.

Required for v1 campaigns and rejected for v2 campaigns.

Campaign ID. Required except in its own Campaign strategy session.

YouTube sponsorship statuses used during candidate discovery.

Citation window start date (ISO 8601). Must match candidate discovery.

Durable Reddit SocialContent or YouTube SocialAccount ID; omit for creation campaigns.

Required for v2 page-refresh campaigns and rejected for creation campaigns.

Use SocialContent for Reddit Engagement and SocialAccount for YouTube Engagement; omit for creation campaigns.

The Brand Kit ID to add the page to.

The web page URL. Must be unique within the Brand Kit.

The Brand Kit ID to add the topic to.

The topic name. Must be unique within the Brand Kit.

Optional. Named color from the platform palette. If omitted, a color is auto-assigned.

The Brand Kit ID that owns the prompt.

The ID of the prompt to remove.

The Brand Kit ID that owns the tag.

The tag ID to delete.

The Brand Kit ID

The IDs of the writing rules to delete (up to 10)

The ID of the grid column to delete.

The ID of the grid.

The ID of the grid table (sheet).

The Brand Kit ID that owns the topic.

The topic ID to delete.

The Brand Kit ID whose draft should be discarded.

Brand Kit ID.

Maximum ranked candidates returned for each proposal. Defaults to 5.

The ID of the Brand Kit

The observed_creative_id of the ad to look up

Filter by the country codes the answers were collected for

End date for metrics (ISO 8601). Defaults to the last analysis date.

Select specific fields to return. **Available fields:** - **observed_creative_id**: Fingerprint identifying one normalized creative observed in collected answers, hashed from advertiser domain, destination, title, body and image. Not an OpenAI ad ID. - **observed_family_id**: Looser fingerprint hashed from advertiser domain and a single anchor, so creative variants of the same ad collapse together. Not an OpenAI ad ID. - **advertiser_name**: Advertiser name, falling back to the domain when unknown - **advertiser_domain**: Canonical advertiser domain - **advertiser_type**: Relationship to the Brand Kit: 'owned', 'competitor' or 'other' - **logo_url**: Advertiser logo, falling back to the favicon - **title**: Ad headline - **body**: Ad copy - **image_url**: Creative image. Returned by get_aeo_ad only. - **target_url**: Normalized destination URL. Returned by get_aeo_ad only. - **appearances**: Observed occurrences of this ad in the selected period - **answers**: Distinct answers this ad appeared in during the selected period - **prompts**: Distinct prompts this ad appeared under during the selected period - **frequency**: Percentage of answers for those prompts that carried this ad (0-100) - **first_seen**: Date this ad was first observed (ISO 8601). Lifetime, not windowed. - **last_seen**: Date this ad was last observed (ISO 8601). Lifetime, not windowed. - **days_active**: Days between first and last observation, inclusive

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **topic_id** (EQ, IN): Filter by the topic IDs of the prompts the ad was observed under. An ad observed under several topics is returned for each of them. - **prompt_id** (EQ, IN): Filter by the prompt IDs the ad was observed under - **brand_mentioned** (EQUALS): Filter by prompt query type: brand or category

Filter by persona IDs

Start date for metrics (ISO 8601). Defaults to 1 month ago.

Filter by tags. Object form { "operator": "IN" | "HAS_ALL" | "NOT_IN", "value": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.

The ID of the Brand Kit

The citation URL to look up. URL-encode special characters; the server CGI-unescapes before lookup.

Filter metrics by country codes

End date for metrics (ISO 8601). Defaults to today.

Select specific fields to return. **Available fields:** - **url**: The cited URL - **domain**: Domain ID - **domain_name**: Name of the domain - **domain_category**: Category: Owned, Competitors, Social, etc. - **logo_url**: URL to the domain logo - **citation_count**: Total number of citations for this URL - **citation_count_trend**: Change in citation count vs previous period - **citation_share**: Percentage of total citations (0-100) - **citation_share_trend**: Change in citation share vs previous period - **citation_rate**: Percentage of answers citing this URL (0-100) - **citation_rate_trend**: Change in citation rate vs previous period - **influence_score**: Overall influence score (0-100) - **influence_score_breakdown**: Breakdown: coverage_score, impact_score, da_score - **page_type**: Type of page - **brand_mentioned**: Whether brand is mentioned on the page - **brand_sentiment**: Sentiment toward brand on the page - **mentioned_competitor_domains**: Competitors mentioned on the page - **domain_authority**: Domain authority score - **social**: Platform-neutral social content and account enrichment

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **domain_category** (EQUALS, IN): Filter by domain category - **domain_id** (EQ, IN): Filter by domain ID - **topic_id** (EQ, IN): Filter by topic ID - **brand_mentioned** (EQUALS): Filter by query type: brand or category - **page_type** (EQUALS): Filter by page type - **brand_referenced** (EQ): Filter by whether brand is referenced on the citing page - **brand_sentiment** (EQUALS): Filter by brand sentiment - **mentioned_competitor_domains** (IN): Filter by competitor domain IDs mentioned on the citing page - **url** (CONTAINS): Filter by case-insensitive substring match on the citation URL. Matches against the normalized URL (without scheme or www).

Filter metrics by persona IDs

Filter metrics by AI providers

Start date for metrics (ISO 8601). Defaults to 1 month ago.

Filter by tags. Object form { "operator": "IN" | "HAS_ALL" | "NOT_IN", "value": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.

Resource ID

Optional Brand Kit ID to filter content updates by

Select specific fields to return. **Available fields:** - **id**: Unique identifier for the content update - **url**: The URL associated with the content update - **type**: Type of content update - **source**: Source that created the content update - **brand_kit_id**: ID of the associated Brand Kit - **workspace_id**: ID of the associated workspace - **created_at**: When the content update was created - **updated_at**: When the content update was last updated - **change_detection**: Change detection for this content update: detection status, the categories of detected changes, and whether a before/after diff is available. On a single-update fetch it also carries a nested `changes` array (the before/after diff). Null when change detection has not run for the update, including workspaces where it is not enabled.

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **url** (EQUALS, CONTAINS): Filter by content update URL - **type** (EQ, IN): Filter by content update type - **source** (EQ, IN): Filter by content update source - **brand_kit_id** (EQ): Filter by Brand Kit ID - **created_at** (GT, LT, GEQ, LEQ): Filter by creation date - **has_changes** (EQ): Filter to content updates where change detection found at least one confirmed change (true) or found none / has no detection run (false)

Include related resources. **Available includes:** - **metadata_entries**: Include metadata key-value pairs for each event

ID of the workspace to retrieve results from. If not provided, returns results from all workspaces the user belongs to.

The Brand Kit ID to inspect.

Resource ID

Select specific fields to return. **Available fields:** - **id**: Unique identifier for the answer - **created_at**: When the answer was created - **text**: The full answer text content - **provider**: AI provider(chat_gpt, gemini, perplexity, google_ai_mode, google_ai_overview) - **country**: Country code for this answer (e.g., US, GB) - **brand_mentioned**: Whether the brand was mentioned in the answer - **brand_cited**: Whether the brand was cited in the answer - **citations.id**: Citation ID - **citations.url**: Citation URL - **citations.title**: Citation title - **citations.position**: Citation position in the answer - **mentions.id**: Mention ID - **mentions.name**: Mentioned entity name - **mentions.position**: Mention position in the answer - **persona.id**: Persona ID - **persona.name**: Persona name - **persona.description**: Persona description

Include related resources. **Available includes:** - **citations**: Include citations with domain details - **mentions**: Include entity mentions with domain details - **persona**: Include persona details

Resource ID

Select specific fields to return. **Available fields:** - **id**: Unique identifier for the Brand Kit - **workspace_name**: Name of the workspace this Brand Kit belongs to - **brand_name**: Name of the brand - **brand_url**: URL of the brand website - **brand_about**: Description/overview of the brand - **writing_persona**: The persona/voice used in brand writing - **writing_tone**: The tone of voice for brand content - **status**: Brand Kit status (pending, processing, generated, setup_flow_generated, failed, user_edited, published) - **unpublished_changes**: True when the draft version has changes not yet published. - **created_at**: When the Brand Kit was created - **updated_at**: When the Brand Kit was last updated - **draft_version_user_id**: ID of the user who last edited the draft version - **draft_version_playbook_id**: ID of the playbook that last edited the draft version - **freshener_playbook_id**: ID of the Freshener Playbook associated with this Brand Kit, if any - **product_lines.id**: Product line ID - **product_lines.name**: Product line name - **product_lines.details**: Product line details - **product_lines.positioning**: Product positioning - **product_lines.ideal_customer_profile**: Ideal customer profile - **product_lines.url**: Product line URL - **product_lines.generation_status**: Generation status (pending, running, success, error) - **audiences.id**: Audience ID - **audiences.name**: Audience name - **audiences.description**: Audience description - **content_types.id**: Content type ID - **content_types.name**: Content type name - **content_types.template_outline**: Template outline - **content_types.cta_text**: Call-to-action text - **content_types.cta_url**: Call-to-action URL - **content_types.header_case**: Header case style - **content_types.header_case_custom_value**: Custom header case value - **content_types.generation_status**: Generation status (pending, running, success, error) - **regions.id**: Region ID - **regions.name**: Region name - **regions.description**: Region description - **regions.icon_name**: Icon name - **writing_rules.id**: Writing rule ID - **writing_rules.text**: Writing rule text - **custom_variables.id**: Custom variable ID - **custom_variables.name**: Custom variable name - **custom_variables.value**: Custom variable value - **logo_variants.id**: Logo variant ID - **logo_variants.name**: Logo variant name - **logo_variants.background_color**: Background color as a hex value (e.g. #ffffff) - **logo_variants.usage_instructions**: Instructions for agents on when and how to use this logo - **logo_variants.file_url**: URL of the uploaded logo image - **logo_sizes.id**: Logo size ID - **logo_sizes.name**: Logo size name - **logo_sizes.width**: Width in pixels - **logo_sizes.height**: Height in pixels - **logo_sizes.usage_instructions**: Instructions for agents on when and how to use this logo size - **usage_rules.id**: Usage rule ID - **usage_rules.applies_to**: Category this rule applies to: "logo" (placement, spacing, backgrounds), "typography" (font usage, sizing), or "color" (palette usage, backgrounds, data viz) - **usage_rules.name**: Usage rule text - **palettes.id**: Palette ID - **palettes.name**: Palette name - **palettes.colors**: Colors in this palette - **fonts.id**: Font ID - **fonts.name**: Font name - **fonts.usage_instructions**: Usage instructions for agents - **fonts.google_font_link**: Google Fonts URL for this font - **fonts.file_url**: URL of the uploaded font file - **type_sizes.id**: Type size ID - **type_sizes.font_id**: ID of the associated font - **type_sizes.name**: Type size name - **type_sizes.weight**: Font weight - **type_sizes.size**: Font size in pixels - **type_sizes.line_height**: Line height multiplier (e.g. 1.5) - **type_sizes.usage_instructions**: Usage instructions for agents - **visual_examples.id**: Visual example ID - **visual_examples.title**: Title of the visual example - **visual_examples.sample_url**: Optional URL to a live sample - **visual_examples.file_url**: URL of the uploaded image - **visual_examples.usage_instructions**: Instructions for agents on when and how to use this visual example - **visual_examples.visual_use_case_id**: ID of the Visual Use Case this visual example is grouped under - **visual_use_cases.id**: Visual use case ID - **visual_use_cases.name**: Visual use case name - **visual_use_cases.instructions**: Free-form instructions for when and how to apply this visual use case

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **workspace_name** (EQUALS, CONTAINS): Filter by workspace name - **brand_name** (EQUALS, CONTAINS): Filter by brand name - **brand_url** (EQUALS, CONTAINS): Filter by brand URL - **status** (EQUALS, IN): Filter by Brand Kit status - **created_at** (EQ, GT, LT, GEQ, LEQ): Filter by creation date - **product_lines.id** (EQ, IN): Filter by product line ID - **product_lines.name** (EQUALS, CONTAINS): Filter by product line name - **product_lines.details** (CONTAINS): Find product lines whose details contain a substring - **product_lines.positioning** (CONTAINS): Find product lines whose positioning contains a substring - **product_lines.ideal_customer_profile** (CONTAINS): Find product lines whose ICP contains a substring - **audiences.id** (EQ, IN): Filter by audience ID - **audiences.name** (EQUALS, CONTAINS): Filter by audience name - **content_types.id** (EQ, IN): Filter by content type ID - **content_types.name** (EQUALS, CONTAINS): Filter by content type name - **content_types.template_outline** (CONTAINS): Find content types whose template_outline contains a substring - **regions.id** (EQ, IN): Filter by region ID - **regions.name** (EQUALS, CONTAINS): Filter by region name - **writing_rules.id** (EQ, IN): Filter by writing rule ID - **writing_rules.text** (CONTAINS): Find writing rules containing a substring (case-insensitive) - **custom_variables.id** (EQ, IN): Filter by custom variable ID - **custom_variables.name** (EQUALS, CONTAINS): Filter by custom variable name (e.g. "Red List") - **custom_variables.value** (CONTAINS): Find custom variables whose value contains a substring - **logo_variants.id** (EQ, IN): Filter by logo variant ID - **logo_variants.name** (EQUALS, CONTAINS): Filter by logo variant name - **logo_sizes.id** (EQ, IN): Filter by logo size ID - **logo_sizes.name** (EQUALS, CONTAINS): Filter by logo size name - **usage_rules.id** (EQ, IN): Filter by usage rule ID - **usage_rules.applies_to** (EQUALS, IN): Filter by category this rule applies to - **usage_rules.name** (CONTAINS): Find usage rules whose text contains a substring - **palettes.id** (EQ, IN): Filter by palette ID - **palettes.name** (EQUALS, CONTAINS): Filter by palette name - **fonts.id** (EQ, IN): Filter by font ID - **fonts.name** (EQUALS, CONTAINS): Filter by font name - **type_sizes.id** (EQ, IN): Filter by type size ID - **type_sizes.font_id** (EQ, IN): Filter by associated font ID - **type_sizes.name** (EQUALS, CONTAINS): Filter by type size name - **visual_examples.id** (EQ, IN): Filter by visual example ID - **visual_examples.title** (EQUALS, CONTAINS): Filter by visual example title - **visual_use_cases.id** (EQ, IN): Filter by visual use case ID - **visual_use_cases.name** (EQUALS, CONTAINS): Filter by visual use case name

Include related resources. **Available includes:** - **product_lines**: Include product lines for this Brand Kit (can nest: competitors). Each product line has positioning, details, and ideal customer profile. Competitors include domain names, useful for link exclusion in content (can nest: competitors) - **audiences**: Include target audiences for this Brand Kit (can nest: writing_rules). Audiences define who the content is for. Nested writing_rules are scoped specifically to that audience (can nest: writing_rules) - **content_types**: Include content types for this Brand Kit (can nest: content_samples, writing_rules). Each content type has a template_outline defining structure and conventions. Nested content_samples provide reference examples; nested writing_rules are scoped to that content type (can nest: content_samples, writing_rules) - **regions**: Include regions for this Brand Kit (can nest: writing_rules). Regions define geographic/market-specific guidelines. Nested writing_rules are scoped specifically to that region (can nest: writing_rules) - **writing_rules**: Include global writing rules for this Brand Kit. These apply to all content. For content-type, audience, or region-specific rules, use the nested writing_rules under those includes instead - **custom_variables**: Include custom variables for this Brand Kit. Custom variables store brand-specific data such as forbidden language lists (Red Lists), customer quotes, terminology guidelines, or other reusable content - **logo_variants**: Include logo variants for this Brand Kit - **logo_sizes**: Include logo sizes for this Brand Kit - **usage_rules**: Include usage rules for this Brand Kit — covers logo placement, typography, color usage, and visual example styling. Filter by applies_to field to find rules for a specific category - **palettes**: Include color palettes for this Brand Kit - **fonts**: Include fonts for this Brand Kit - **type_sizes**: Include type sizes for this Brand Kit - **visual_examples**: Include visual examples for this Brand Kit — editorial illustrations, AI image generation templates, data visualizations, and infographic templates. Check titles for usage guidance (some are marked as AI-generation templates) - **visual_use_cases**: Include visual use cases for this Brand Kit — named groupings of visual examples with shared instructions for when and how to apply them. Every visual example belongs to a visual use case (via visual_use_case_id).

Brand Kit version to read from (`active` or `draft`). Defaults to `active`.

ID of the workspace to retrieve brand kits from. If not provided, returns brand kits from all workspaces the user belongs to.

Resource ID

Select specific fields to return. **Available fields:** - **id**: Campaign ID - **name**: Campaign name - **status**: Campaign status - **action_type**: Behavior this campaign performs - **resource_type**: Action-derived resource type this campaign works on - **brand_kit_id**: Brand Kit this campaign belongs to - **workspace_id**: Workspace this campaign belongs to - **strategy_playbook_id**: Strategy playbook generated for this campaign - **opportunity_schema_version**: Persisted Opportunity schema version - **created_at**: When the campaign was created - **updated_at**: When the campaign was last updated - **action_grid_id**: Action grid ID to use with grid tools - **action_grid_table_id**: Action grid table ID to use with grid tools - **custom_instructions**: Campaign-specific guidance for working related opportunities - **resource_configuration**: Campaign scope. Page refresh returns topics and folders; page creation returns topics and tags. - **recommendation**: Recommendation record, including the current hypothesis and brief_markdown, original values, and source context, if present

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **name** (EQUALS, CONTAINS): Filter by campaign name - **status** (EQUALS, IN): Filter by campaign status - **workspace_id** (EQ, IN): Filter by workspace ID - **brand_kit_id** (EQ, IN): Filter by Brand Kit ID - **resource_type** (EQUALS, IN): Filter by campaign resource type

The ID of the grid containing the executions.

IDs of the row executions to check (max 50).

Resource ID

Select specific fields to return. **Available fields:** - **id**: Unique identifier for the Brand Kit - **brand_name**: Name of the brand - **brand_url**: URL of the brand website - **countries**: Array of country codes for brand targeting (e.g., ["US", "GB", "CA"]) - **aeo_enabled**: Whether AEO analytics data is available for this Brand Kit - **prompts_count**: Number of prompts/questions associated with this Brand Kit - **brand_customer**: Description of the target customer - **brand_competitors**: Information about brand competitors - **domains**: Owned domains associated with this Brand Kit - **competitors**: AEO competitors with their domain URLs - **personas**: AEO personas for this Brand Kit

ID of the workspace to retrieve results from. If not provided, returns results from all workspaces the user belongs to.

Resource ID

End date for metrics period (YYYY-MM-DD format). Defaults to current date.

Select specific fields to return. **Available fields:** - **id**: Unique identifier for the web page - **url**: URL of the web page - **folder**: Folder name of the web page - **primary_keyword**: Primary keyword of the web page - **tracked**: Whether the page is tracked and scraped to track content changes - **citation_share**: Citation share percentage - what percentage of all citations belong to this page - **citation_share_trend**: Citation share trend compared to previous period - **citation_rate**: Citation rate percentage - how frequently this page is cited among answers with citations - **citation_rate_trend**: Citation rate trend compared to previous period - **unique_cited_questions_count**: Number of unique questions/prompts that cite this page - **unique_cited_questions_count_trend**: Unique cited questions count trend (absolute difference from previous period) - **clicks**: Total Google Search Console clicks for this page - **clicks_trend**: Clicks trend percentage compared to previous period - **impressions**: Total Google Search Console impressions for this page - **impressions_trend**: Impressions trend percentage compared to previous period - **position**: Average Google Search Console position for this page - **position_trend**: Position trend percentage compared to previous period - **ctr**: Click-through rate (clicks / impressions) - **ctr_trend**: CTR trend compared to previous period (absolute difference)

Start date for metrics period (YYYY-MM-DD format). Defaults to 1 month ago.

ID of the brand kit

ID of the web page to get citing prompts for

Filter by country codes (AE, AR, AT, AU, BE, BR, CA, CH, CL, CN, CO, CZ, DE, DK, ES, FI, FR, GB, GR, HR, HU, ID, IE, IL, IN, IS, IT, JP, KE, KR, MX, MY, NG, NL, NO, NZ, PE, PH, PL, PT, SA, SE, SG, TH, TR, TW, US, VN, ZA)

End date for analysis period (ISO 8601 format, defaults to today)

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the prompt - **text**: The prompt text - **keyword**: Associated keyword for the prompt - **topic_id**: ID of the associated topic (if any) - **volume**: Relative volume score (0-1) indicating search popularity - **total_answers**: Total number of AI answers with citations - **answers_with_citations**: Number of answers citing this web page - **citation_rate**: Ratio of answers citing this page to total answers - **mention_rate**: Ratio of answers mentioning the brand - **citation_rate_trend**: Change in citation rate vs previous period - **mention_rate_trend**: Change in mention rate vs previous period - **volume_trend**: Change in volume vs previous period

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **topic.name** (EQUALS, CONTAINS): Filter by topic name

Include related resources. **Available includes:** - **topic**: Include the associated topic with name

Page number

Items per page

Filter by persona IDs

Filter by AI providers (e.g., chat_gpt, gemini, perplexity, google_ai_mode, google_ai_overview, claude, grok, microsoft_copilot)

Start date for analysis period (ISO 8601 format, defaults to 1 month ago)

Filter by topic IDs

The ID of the Playbook session to retrieve.

Returns events after this ID (cursor pagination). Omit to start from the beginning.

Maximum number of events to return (max 50). Defaults to 20.

ID of the question/prompt to get answers for

Comma-separated country codes to filter by using the ISO 3166-1 alpha-2 format (e.g., AE,AR,AT,AU,BE,BR,CA,CH,CL,CN,CO,CZ,DE,DK,ES,FI,FR,GB,GR,HR,HU,ID,IE,IL,IN,IS,IT,JP,KE,KR,MX,MY,NG,NL,NO,NZ,PE,PH,PL,PT,SA,SE,SG,TH,TR,TW,US,VN,ZA)

End date for analysis period (ISO 8601 format, defaults to today)

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the answer - **created_at**: When the answer was created - **text**: The answer text content (truncated to 200 chars) - **provider**: AI provider(chat_gpt, gemini, perplexity, google_ai_mode, google_ai_overview) - **country**: Country code for this answer (e.g., US, GB) - **brand_mentioned**: Whether the brand was mentioned in the answer - **brand_cited**: Whether the brand was cited in the answer

Include related resources. **Available includes:** - **persona**: Include persona details

Page number

Items per page

Comma-separated persona IDs to filter by.Use "default" for the default persona.

Sort field. Prefix with - for descending. **Available sort fields:** - **created_at/-created_at**: Sort by answer creation date

Start date for analysis period (ISO 8601 format, defaults to 1 month ago)

The ID of the Brand Kit

Resource ID

Select specific fields to return. **Available fields:** - **id**: Unique identifier for the report - **name**: Report name - **created_at**: When the report was created - **updated_at**: When the report was last updated - **modules.id**: Unique identifier for the module - **modules.title**: Module display title - **modules.metrics**: Metrics being measured (e.g., citation_rate, mention_rate) - **modules.dimensions**: Dimensions for grouping data (e.g., date, provider) - **modules.grain**: Time aggregation level (daily, weekly, monthly, total) - **modules.visualization**: Chart type (value, line, bar, table) - **modules.filters**: Filter configuration including date range and providers - **modules.layout**: Grid layout position (x, y, w, h)

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **name** (EQUALS, CONTAINS): Filter by report name

Include related resources. **Available includes:** - **modules**: Include the report modules with their configurations

The Brand Kit ID

The sentiment theme ID to drill into. Use query_analytics with dimensions=[theme] to discover available theme IDs first.

Filter by country codes (ISO 3166-1 alpha-2)

End date (YYYY-MM-DD). Defaults to yesterday. Must be before today.

Page number. Default: 1

Results per page (1-50). Default: 10

Filter by persona IDs

Filter by AI providers

Start date (YYYY-MM-DD). Default: 30 days ago

Filter by topic IDs

The workflow execution UUID returned by run_workflow.

MIME type to index the document as. Typically matches the `content_type` passed to `knowledge_base_create_direct_upload`, but may intentionally differ to select a different loader (e.g. registering a `text/csv` blob as `text/plain` to bypass CSV-specific parsing).

The ID of the Knowledge Base to register the document with.

Display name for the document.

The `signed_id` returned by `knowledge_base_create_direct_upload`.

Optional single-level key/value hash to attach to the document. Filterable via `search_knowledge_base`.

The ID of the Knowledge Base to add URLs to.

One or more absolute URLs starting with `http://` or `https://` (e.g. `https://example.com/page`). Each URL becomes its own document. Bare hostnames without a scheme are rejected.

Optional single-level hash applied identically to every new document. Replaces existing metadata (no merge). Filterable via search_knowledge_base.

Size of the file in bytes. Maximum: 256 MB.

Base64-encoded MD5 digest of the file contents.

MIME type of the file.

The filename including extension, e.g. "report.pdf" or "transcript.md".

The ID of the Knowledge Base the file will be ingested into.

The ID of the Knowledge Base to delete.

The ID of the document to delete.

The ID of the Knowledge Base the document belongs to.

The ID of the document to read.

The ID of the Knowledge Base the document belongs to.

Maximum characters to return in this call (default 200000, cap 500000). For larger documents, paginate via `next_offset`.

Character offset to start reading from (default 0). Use the `next_offset` from a previous call to paginate.

The ID of the Knowledge Base to inspect.

Optional. Cursor token returned by a previous call. Pass it back to fetch the next page.

Optional. Filter the documents array to only the listed document IDs.

Optional. Page size for the documents array (1–100, default 25).

Omit to create a new Knowledge Base; pass it to update an existing one.

Display name. Required on create; optional on update (omit to leave unchanged).

Workspace ID for the new Knowledge Base. Required on create when the caller has access to multiple workspaces; inferred otherwise. Ignored on update (workspace is fixed by the existing Knowledge Base).

The ID of the document whose metadata to replace.

The ID of the Knowledge Base the document belongs to.

Single-level key/value hash. Replaces the existing user-facing metadata in full. Values must be a string, number, or boolean (no nested objects / arrays). String values are capped at 512 characters.

The ID of the Brand Kit

Filter by the country codes the answers were collected for

End date for metrics (ISO 8601). Defaults to the last analysis date.

Select additional fields to return. **Optional fields:** - **observed_creative_id**: Fingerprint identifying one normalized creative observed in collected answers, hashed from advertiser domain, destination, title, body and image. Not an OpenAI ad ID. - **observed_family_id**: Looser fingerprint hashed from advertiser domain and a single anchor, so creative variants of the same ad collapse together. Not an OpenAI ad ID. - **advertiser_name**: Advertiser name, falling back to the domain when unknown - **advertiser_domain**: Canonical advertiser domain - **advertiser_type**: Relationship to the Brand Kit: 'owned', 'competitor' or 'other' - **logo_url**: Advertiser logo, falling back to the favicon - **title**: Ad headline - **body**: Ad copy - **image_url**: Creative image. Returned by get_aeo_ad only. - **target_url**: Normalized destination URL. Returned by get_aeo_ad only. - **appearances**: Observed occurrences of this ad in the selected period - **answers**: Distinct answers this ad appeared in during the selected period - **prompts**: Distinct prompts this ad appeared under during the selected period - **frequency**: Percentage of answers for those prompts that carried this ad (0-100) - **first_seen**: Date this ad was first observed (ISO 8601). Lifetime, not windowed. - **last_seen**: Date this ad was last observed (ISO 8601). Lifetime, not windowed. - **days_active**: Days between first and last observation, inclusive

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **topic_id** (EQ, IN): Filter by the topic IDs of the prompts the ad was observed under. An ad observed under several topics is returned for each of them. - **prompt_id** (EQ, IN): Filter by the prompt IDs the ad was observed under - **brand_mentioned** (EQUALS): Filter by prompt query type: brand or category

Page number

Items per page

Filter by persona IDs

Start date for metrics (ISO 8601). Defaults to 1 month ago.

Filter by tags. Object form { "operator": "IN" | "HAS_ALL" | "NOT_IN", "value": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.

The ID of the Brand Kit

Filter by the country codes the answers were collected for

End date for metrics (ISO 8601). Defaults to the last analysis date.

Select additional fields to return. **Optional fields:** - **advertiser_id**: Stable advertiser identifier: the AirOps domain ID of the advertiser. Null when the domain could not be resolved, in which case advertiser_domain is the identity. - **advertiser_name**: Advertiser name, falling back to the domain when unknown. Resolved per advertiser, so it can vary across creatives. - **advertiser_domain**: Canonical advertiser domain - **advertiser_type**: Relationship to the Brand Kit: 'owned', 'competitor' or 'other' - **logo_url**: Advertiser logo, falling back to the favicon - **ads**: Unique ads this advertiser ran in the selected period - **appearances**: Observed occurrences of this advertiser's ads in the selected period - **answers**: Distinct answers this advertiser appeared in during the selected period - **prompts**: Distinct prompts this advertiser appeared under during the selected period - **first_seen**: Date this advertiser was first observed (ISO 8601). Lifetime, not windowed. - **last_seen**: Date this advertiser was last observed (ISO 8601). Lifetime, not windowed.

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **topic_id** (EQ, IN): Filter by the topic IDs of the prompts the advertiser was observed under - **prompt_id** (EQ, IN): Filter by the prompt IDs the advertiser was observed under - **brand_mentioned** (EQUALS): Filter by prompt query type: brand or category

Page number

Items per page

Filter by persona IDs

Sort field. Prefix with - for descending. **Available sort fields:** - **advertiser_name/-advertiser_name**: Sort alphabetically by advertiser name - **advertiser_domain/-advertiser_domain**: Sort alphabetically by advertiser domain - **ads/-ads**: Sort by unique ad count. Use -ads for the most prolific first. - **appearances/-appearances**: Sort by observed occurrences - **answers/-answers**: Sort by distinct answers appeared in - **prompts/-prompts**: Sort by distinct prompts appeared under - **first_seen/-first_seen**: Sort by first observation date - **last_seen/-last_seen**: Sort by last observation date

Start date for metrics (ISO 8601). Defaults to 1 month ago.

Filter by tags. Object form { "operator": "IN" | "HAS_ALL" | "NOT_IN", "value": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.

The ID of the Brand Kit

End date (ISO 8601), inclusive. Defaults to today. As on the Agent Analytics tab, requests stamped exactly 00:00:00 the next day are also included, dated that next day.

Select additional fields to return. **Optional fields:** - **date**: Day of the requests (ISO 8601). Can be the day after end_date for requests stamped exactly 00:00:00 that day. - **platform**: Bot platform (engine) that made the requests. One of chat_gpt, claude, perplexity, google_ai_mode, gemini, meta, google, apple, bing, bytedance, commoncrawl, other_bot. Tracked engines are chat_gpt, perplexity, gemini, google_ai_mode, claude; google is Googlebot and GoogleOther, other_bot is any other bot. - **crawl_type**: ai_search: Web Search Crawls, AI search bots fetching pages for search answers (e.g. OAI-SearchBot, PerplexityBot). ai_training: Training Crawls, AI bots collecting pages as training data (e.g. GPTBot, ClaudeBot, Google-Extended). user_browse: AI Agent Visits, AI assistants fetching pages live on behalf of a person (e.g. ChatGPT-User, Claude-User). other: any other bot request (e.g. Googlebot). - **count**: Number of requests

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **platform** (EQUALS, IN): Filter by bot platform - **crawl_type** (EQUALS, IN): Filter by crawl type - **web_page_id** (EQ): Filter to one tracked web page (id from list_pages)

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **date/-date**: Sort by date - **count/-count**: Sort by request count. Use -count for the largest first.

Start date (ISO 8601), inclusive. Defaults to 1 month ago.

The ID of the Brand Kit

Filter metrics by country codes

End date for metrics (ISO 8601). Defaults to today.

Select additional fields to return. **Optional fields:** - **url**: The cited URL - **domain**: Domain ID - **domain_name**: Name of the domain - **domain_category**: Category: Owned, Competitors, Social, etc. - **logo_url**: URL to the domain logo - **citation_count**: Total number of citations for this URL - **citation_count_trend**: Change in citation count vs previous period - **citation_share**: Percentage of total citations (0-100) - **citation_share_trend**: Change in citation share vs previous period - **citation_rate**: Percentage of answers citing this URL (0-100) - **citation_rate_trend**: Change in citation rate vs previous period - **influence_score**: Overall influence score (0-100) - **influence_score_breakdown**: Breakdown: coverage_score, impact_score, da_score - **page_type**: Type of page - **brand_mentioned**: Whether brand is mentioned on the page - **brand_sentiment**: Sentiment toward brand on the page - **mentioned_competitor_domains**: Competitors mentioned on the page - **domain_authority**: Domain authority score - **social**: Platform-neutral social content and account enrichment

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **domain_category** (EQUALS, IN): Filter by domain category - **domain_id** (EQ, IN): Filter by domain ID - **topic_id** (EQ, IN): Filter by topic ID - **brand_mentioned** (EQUALS): Filter by query type: brand or category - **page_type** (EQUALS): Filter by page type - **brand_referenced** (EQ): Filter by whether brand is referenced on the citing page - **brand_sentiment** (EQUALS): Filter by brand sentiment - **mentioned_competitor_domains** (IN): Filter by competitor domain IDs mentioned on the citing page - **url** (CONTAINS): Filter by case-insensitive substring match on the citation URL. Matches against the normalized URL (without scheme or www).

Page number

Items per page

Filter metrics by persona IDs

Filter metrics by AI providers

Sort field. Prefix with - for descending. **Available sort fields:** - **citation_count/-citation_count**: Sort by citation count - **citation_share/-citation_share**: Sort by citation share percentage - **citation_rate/-citation_rate**: Sort by citation rate percentage - **influence_score/-influence_score**: Sort by influence score

Start date for metrics (ISO 8601). Defaults to 1 month ago.

Filter by tags. Object form { "operator": "IN" | "HAS_ALL" | "NOT_IN", "value": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.

The ID of the Brand Kit

Filter metrics by country codes

End date for metrics (ISO 8601). Defaults to today.

Select additional fields to return. **Optional fields:** - **domain_id**: Unique identifier for the domain - **domain_name**: Name of the cited domain - **domain_category**: Category: Owned, Competitors, Social, Communities, etc. - **logo_url**: URL to the domain logo - **citation_count**: Total number of citations for this domain - **citation_count_trend**: Change in citation count vs previous period - **url_count**: Number of unique URLs cited from this domain - **citation_share**: Percentage of total citations (0-100) - **citation_share_trend**: Change in citation share vs previous period - **citation_rate**: Percentage of answers citing this domain (0-100) - **citation_rate_trend**: Change in citation rate vs previous period

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **domain_category** (EQUALS, IN): Filter by domain category - **topic_id** (EQ, IN): Filter by topic ID - **brand_mentioned** (EQUALS): Filter by query type: brand or category - **page_type** (EQUALS): Filter by page type - **brand_referenced** (EQ): Filter by whether brand is referenced on the citing page - **brand_sentiment** (EQUALS): Filter by brand sentiment on the citing page - **domain_name** (CONTAINS): Filter by case-insensitive substring match on the domain name.

Page number

Items per page

Filter metrics by persona IDs

Filter metrics by AI providers

Sort field. Prefix with - for descending. **Available sort fields:** - **citation_count/-citation_count**: Sort by citation count - **citation_share/-citation_share**: Sort by citation share percentage - **citation_rate/-citation_rate**: Sort by citation rate percentage

Start date for metrics (ISO 8601). Defaults to 1 month ago.

Optional Brand Kit ID to filter content updates by

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the content update - **url**: The URL associated with the content update - **type**: Type of content update - **source**: Source that created the content update - **brand_kit_id**: ID of the associated Brand Kit - **workspace_id**: ID of the associated workspace - **created_at**: When the content update was created - **updated_at**: When the content update was last updated - **change_detection**: Change detection for this content update: detection status, the categories of detected changes, and whether a before/after diff is available. On a single-update fetch it also carries a nested `changes` array (the before/after diff). Null when change detection has not run for the update, including workspaces where it is not enabled.

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **url** (EQUALS, CONTAINS): Filter by content update URL - **type** (EQ, IN): Filter by content update type - **source** (EQ, IN): Filter by content update source - **brand_kit_id** (EQ): Filter by Brand Kit ID - **created_at** (GT, LT, GEQ, LEQ): Filter by creation date - **has_changes** (EQ): Filter to content updates where change detection found at least one confirmed change (true) or found none / has no detection run (false)

Include related resources. **Available includes:** - **metadata_entries**: Include metadata key-value pairs for each event

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **created_at/-created_at**: Sort by creation date - **updated_at/-updated_at**: Sort by last update date - **url/-url**: Sort alphabetically by URL

ID of the workspace to retrieve results from. If not provided, returns results from all workspaces the user belongs to.

The ID of the Brand Kit

Filter metrics by country codes

End date for metrics (ISO 8601). Defaults to today.

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the prompt - **text**: The prompt text - **keyword**: Associated keyword for the prompt - **brand_mentioned**: Whether the brand is mentioned in the prompt - **prompt_volume**: Prompt volume level - **search_volume**: Actual search volume behind the prompt_volume level - **topic_id**: ID of the associated topic - **created_at**: When the prompt was created - **updated_at**: When the prompt was last updated - **mention_rate**: Percentage of AI answers mentioning the brand (0-100) - **positive_answer_rate**: Percentage of answers where your brand is positively mentioned, out of all answers where you have been mentioned and sentiment is determined - **citation_rate**: Percentage of AI answers citing the brand (0-100) - **mention_rate_trend**: Change in mention_rate vs previous period - **positive_answer_rate_trend**: Change in positive_answer_rate vs previous period - **citation_rate_trend**: Change in citation_rate vs previous period - **query_fanouts**: Search queries the AI ran internally when answering this question. Each entry has text (the raw query), normalized_text (lowercase/trimmed), and observations_count (how many times it appeared — higher = stronger signal). Empty if query fanout capture is not enabled for your workspace or if we do not support it for this provider. - **countries**: ISO alpha-2 country codes currently assigned to the prompt (live). - **persona_ids**: IDs of personas currently assigned to the prompt (live). Use `list_personas` to resolve to titles. - **platforms**: AI platforms currently assigned to the prompt (live). - **est_answers_mo**: Estimated monthly answer credits this prompt will consume given its current live country, persona, and platform assignments.

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **text** (EQUALS, CONTAINS): Filter by prompt text - **strategy** (EQ, IN): Filter by strategy: 0 = manual, 1 = deep_research - **brand_mentioned** (EQ): Filter by whether brand is mentioned - **topic_id** (EQ, IN): Filter by topic ID - **prompt_volume** (EQUALS, IN): Filter by prompt volume level - **mention_rate** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by mention rate percentage (0-100) - **positive_answer_rate** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by positive answer rate percentage (0-100) - **citation_rate** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by citation rate percentage (0-100) - **country** (EQ, IN): Filter prompts by an assigned country (ISO alpha-2). EQ matches a single code; IN matches any in the list. - **persona_id** (EQ, IN): Filter prompts by an assigned persona ID. Use `list_personas` to discover persona IDs. - **platform** (EQ, IN): Filter prompts by an assigned AI platform.

Include related resources. **Available includes:** - **topic**: Include the associated topic - **tags**: Include the associated tags

Page number

Items per page

Filter metrics by persona IDs

Filter metrics by AI providers

Sort field. Prefix with - for descending. **Available sort fields:** - **text/-text**: Sort alphabetically by prompt text - **created_at/-created_at**: Sort by creation date - **prompt_volume/-prompt_volume**: Sort by prompt volume level - **mention_rate/-mention_rate**: Sort by mention rate - **positive_answer_rate/-positive_answer_rate**: Sort by positive answer rate - **citation_rate/-citation_rate**: Sort by citation rate

Start date for metrics (ISO 8601). Defaults to 1 month ago.

Filter by tags. Object form { "operator": "IN" | "HAS_ALL" | "NOT_IN", "value": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.

The ID of the Brand Kit

When set, filter to answers where the brand was (or was not) mentioned.

Filter by ISO alpha-2 country codes.

End date (ISO 8601) on aeo_analyses.created_at. Defaults to today.

Select additional fields to return. **Optional fields:** - **id**: Answer ID - **date**: Analysis date (YYYY-MM-DD) - **text**: Answer text. Truncated to 200 chars with ellipsis on list; full on show. - **prompt**: Prompt (question) text - **intent_stage**: Prompt intent stage - **citations**: URLs cited by the answer (deduped) - **mentions**: Brand names mentioned in the answer (self brand + competitors) - **persona**: Persona name or "default" - **provider**: AI provider - **country**: ISO alpha-2 country code - **brand_mentioned**: Whether the brand was mentioned in this answer

Page number

Items per page

Filter answers by a single prompt (question) ID.

Filter by AI providers.

Start date (ISO 8601) on aeo_analyses.created_at. Defaults to 30 days ago.

The Playbook session whose artifact comments should be listed.

Exact artifact path (e.g. artifacts/external/report.md). Omit to list all artifacts.

Brand Kit ID.

Select additional fields to return. Default fields (id, brand_name, brand_about, brand_url, workspace_name, brand_management_enabled, aeo_enabled) are always included. **Optional fields:** - **created_at**: When the Brand Kit was created - **updated_at**: When the Brand Kit was last updated

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **workspace_name** (EQUALS, CONTAINS): Filter by workspace name - **brand_name** (EQUALS, CONTAINS): Filter by brand name - **brand_url** (EQUALS, CONTAINS): Filter by brand URL - **brand_management_enabled** (EQ): Filter by whether the Brand Kit is enabled for brand management - **aeo_enabled** (EQ): Filter by whether AEO analytics data is available

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **brand_name/-brand_name**: Sort alphabetically by brand name - **created_at/-created_at**: Sort by creation date

Brand Kit version to read from (`active` or `draft`). Defaults to `active`.

ID of the workspace to retrieve results from. If not provided, returns results from all workspaces the user belongs to.

Select additional fields to return. Default fields (id, name, status, action_type, resource_type, brand_kit_id, workspace_id, strategy_playbook_id, opportunity_schema_version, created_at, updated_at) are always included. **Optional fields:** - **action_grid_id**: Action grid ID to use with grid tools - **action_grid_table_id**: Action grid table ID to use with grid tools - **custom_instructions**: Campaign-specific guidance for working related opportunities - **resource_configuration**: Campaign scope. Page refresh returns topics and folders; page creation returns topics and tags.

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **name** (EQUALS, CONTAINS): Filter by campaign name - **status** (EQUALS, IN): Filter by campaign status - **workspace_id** (EQ, IN): Filter by workspace ID - **brand_kit_id** (EQ, IN): Filter by Brand Kit ID - **resource_type** (EQUALS, IN): Filter by campaign resource type

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **name/-name**: Sort by campaign name - **created_at/-created_at**: Sort by creation date - **updated_at/-updated_at**: Sort by last updated date

Select additional fields to return. **Optional fields:** - **id**: Grid ID (use as grid_id in read_grid/write_grid) - **name**: Grid name - **workspace_id**: Workspace this grid belongs to

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **name** (EQUALS, CONTAINS): Filter by grid name - **workspace_id** (EQ): Filter by workspace ID

Include related resources. **Available includes:** - **grid_tables**: Include grid tables (sheets) with their columns (can nest: grid_columns)

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **name/-name**: Sort by grid name - **updated_at/-updated_at**: Sort by last updated date - **created_at/-created_at**: Sort by creation date

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the Knowledge Base - **name**: Human-readable name of the Knowledge Base - **workspace_id**: ID of the workspace this Knowledge Base belongs to - **status**: Current status. Only "ready" Knowledge Bases can be searched. - **document_count**: Total number of documents in this Knowledge Base

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **workspace_name** (EQUALS, CONTAINS): Filter by workspace name - **name** (EQUALS, CONTAINS): Filter by Knowledge Base name. Use EQUALS for exact match, CONTAINS for partial. - **workspace_id** (EQ): Filter by workspace ID to list Knowledge Bases from a specific workspace.

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **name/-name**: Sort alphabetically by Knowledge Base name - **created_at/-created_at**: Sort by creation date

Campaign ID.

Next cursor for a Reddit Thread Creation Campaign returned by the previous page.

Maximum number of opportunities to return. Defaults to 30.

Optional item statuses for v1 or parent statuses for v2. Defaults to all.

ID of the brand kit to retrieve web page metrics for

Optional configured Amplitude event names to include. If omitted, all active Amplitude events configured for the brand kit are included when the feature is enabled.

End date for analysis period (ISO 8601 format, defaults to today)

Optional configured GA4 key event names to include. If omitted, all active key events configured for the brand kit are included.

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the web page - **web_page_id**: Web page ID (same as id) - **url**: Full URL of the web page - **folder_name**: First path segment of the URL (folder/section) - **primary_keyword**: Primary keyword associated with this page - **tracked**: Whether the page is tracked and scraped to track content changes - **citations_count**: Number of citations this page received - **citations_count_diff**: Percentage change in citations vs comparison period - **citation_rate**: Ratio of citing answers to total answers with citations - **citation_rate_diff**: Absolute change in citation rate vs comparison period - **prompts_count**: Number of unique prompts citing this page - **prompts_count_diff**: Change in prompts count vs comparison period - **clicks**: Google Search Console clicks - **clicks_diff**: Percentage change in clicks vs comparison period - **impressions**: Google Search Console impressions - **impressions_diff**: Percentage change in impressions vs comparison period - **ctr**: Click-through rate (clicks/impressions) - **ctr_diff**: Absolute change in CTR vs comparison period - **position**: Average search position - **position_diff**: Percentage change in position vs comparison period - **traffic**: GA4 active users - **traffic_diff**: Percentage change in traffic vs comparison period - **sessions**: GA4 sessions count - **sessions_diff**: GA4 Percentage change in sessions vs comparison period - **engagement**: GA4 engaged sessions - **engagement_diff**: GA4Percentage change in engagement vs comparison period - **average_session_engagement**: GA4 Average session duration in seconds - **average_session_engagement_diff**: GA4 Percentage change in average session duration vs comparison period - **events**: Configured GA4 key events for this page. Each event includes event_name, event_count, and event_diff. - **amplitude_events**: Configured Amplitude events for this page. Each event includes event_name, totals, and totals_diff. - **user_browse**: AI Agent Visits: requests from AI assistants fetching this page live on behalf of a person (e.g. ChatGPT-User, Claude-User) - **ai_training**: Training Crawls: requests from AI bots collecting this page as training data (e.g. GPTBot, ClaudeBot, Google-Extended) - **ai_search**: Web Search Crawls: requests from AI search bots fetching this page for search answers (e.g. OAI-SearchBot, PerplexityBot)

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **clicks** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by GSC clicks count - **impressions** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by GSC impressions count - **ctr** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by click-through rate - **position** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by average search position - **citations_count** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by citation count - **citation_rate** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by citation rate - **prompts_count** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by prompts count - **traffic** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by GA4 traffic - **sessions** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by GA4 sessions - **engagement** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by GA4 engaged sessions - **average_session_engagement** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by average session duration - **user_browse** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by AI Agent Visits - **ai_training** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by Training Crawls - **ai_search** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by Web Search Crawls - **clicks_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by clicks change percentage - **impressions_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by impressions change percentage - **ctr_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by CTR change - **position_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by position change percentage - **citations_count_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by citations change percentage - **citation_rate_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by citation rate change - **prompts_count_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by prompts count change - **traffic_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by traffic change percentage - **sessions_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by sessions change percentage - **engagement_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by engagement change percentage - **average_session_engagement_diff** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by average session duration change - **last_refreshed_at** (LEQ): Filter by pages last refreshed before a preset window. Valid values: 1m, 3m, 6m, 1y. - **url** (EQUALS, CONTAINS, STARTS_WITH, IN): Filter by page URL. Use CONTAINS for partial match. - **folder_name** (EQUALS, CONTAINS, STARTS_WITH, IN): Filter by folder/section name - **primary_keyword** (EQUALS, CONTAINS, STARTS_WITH, IN): Filter by primary keyword - **session_source** (EQUALS, CONTAINS, STARTS_WITH, IN): Filter by GA4 session source. Valid values: (direct), google, chatgpt.com, perplexity.ai, perplexity, reddit.com, gemini.google.com, youtube.com, linkedin, linkedin.com, lnkd.in, bing, claude.ai - **session_medium** (EQUALS, CONTAINS, STARTS_WITH, IN): Filter by GA4 session medium. Valid values: organic, cpc, email, social, direct, referral - **tracked** (EQ): Filter by tracked status

Page number

Items per page

Apply a predefined filter preset. **Available presets:** - **almost_page_one**: Pages ranking 10-20 - **losing_clicks**: Pages losing clicks despite stable rankings - **rankings_slipping**: Pages declining in SERP - **losing_ai_visibility**: Pages losing AI citations - **citation_rate_decline**: Pages losing citation rate - **stale_pages**: Pages not updated in 6 months

Sort field. Prefix with - for descending. **Available sort fields:** - **url/-url**: Sort alphabetically by URL - **folder_name/-folder_name**: Sort alphabetically by folder name - **citations_count/-citations_count**: Sort by citation count - **citations_count_diff/-citations_count_diff**: Sort by citation change - **citation_rate/-citation_rate**: Sort by citation rate - **citation_rate_diff/-citation_rate_diff**: Sort by citation rate change - **prompts_count/-prompts_count**: Sort by prompts count - **prompts_count_diff/-prompts_count_diff**: Sort by prompts count change - **clicks/-clicks**: Sort by GSC clicks - **clicks_diff/-clicks_diff**: Sort by clicks change - **impressions/-impressions**: Sort by GSC impressions - **impressions_diff/-impressions_diff**: Sort by impressions change - **ctr/-ctr**: Sort by click-through rate - **ctr_diff/-ctr_diff**: Sort by CTR change - **position/-position**: Sort by search position - **position_diff/-position_diff**: Sort by position change - **traffic/-traffic**: Sort by GA4 traffic - **traffic_diff/-traffic_diff**: Sort by traffic change - **sessions/-sessions**: Sort by GA4 sessions - **sessions_diff/-sessions_diff**: Sort by sessions change - **engagement/-engagement**: Sort by GA4 engagement - **engagement_diff/-engagement_diff**: Sort by engagement change - **average_session_engagement/-average_session_engagement**: Sort by avg session duration - **average_session_engagement_diff/-average_session_engagement_diff**: Sort by avg session duration change - **user_browse/-user_browse**: Sort by AI Agent Visits - **ai_training/-ai_training**: Sort by Training Crawls - **ai_search/-ai_search**: Sort by Web Search Crawls

Start date for analysis period (ISO 8601 format, defaults to 1 month ago)

The ID of the Brand Kit

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the persona - **title**: The persona title - **description**: The persona description - **created_at**: When the persona was created - **updated_at**: When the persona was last updated

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **title** (EQUALS, CONTAINS): Filter by persona title

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **title/-title**: Sort alphabetically by persona title - **created_at/-created_at**: Sort by creation date

The workspace to list sessions from.

Page number (1-based). Defaults to 1.

Number of sessions per page (max 50). Defaults to 20.

Filter sessions by playbook ID.

Full-text search across session name and creator name.

Filter by session status.

The ID of the Brand Kit

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the report - **name**: Report name - **created_at**: When the report was created - **updated_at**: When the report was last updated

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **name** (EQUALS, CONTAINS): Filter by report name

Include related resources. **Available includes:** - **modules**: Include the report modules with their configurations

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **name/-name**: Sort alphabetically by report name - **created_at/-created_at**: Sort by creation date - **updated_at/-updated_at**: Sort by last update

The ID of the Brand Kit

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the tag - **name**: The tag name - **color**: The tag color (hex code)

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **name** (EQUALS, CONTAINS): Filter by tag name

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **name/-name**: Sort alphabetically by tag name - **created_at/-created_at**: Sort by creation date

The ID of the Brand Kit

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the topic - **name**: The topic name - **color**: The topic color (hex code)

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **name** (EQUALS, CONTAINS): Filter by topic name

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **name/-name**: Sort alphabetically by topic name - **created_at/-created_at**: Sort by creation date

Select additional fields to return. **Optional fields:** - **id**: Unique identifier for the workspace - **name**: Human-readable workspace name set by the user - **slug**: URL-friendly identifier derived from workspace name and ID - **tier**: Subscription tier (e.g., "free", "pro", "platform") determining available features

Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`. **Available fields:** - **name** (EQUALS, CONTAINS): Filter by workspace name. Use EQUALS for exact match, CONTAINS for partial. - **tier** (EQ, IN): Filter by subscription tier. Use EQ for single tier, IN for multiple.

Page number

Items per page

Sort field. Prefix with - for descending. **Available sort fields:** - **name/-name**: Sort alphabetically by workspace name (A-Z ascending, Z-A descending) - **created_at/-created_at**: Sort by creation date. Use -created_at for newest first (recommended default).

The Brand Kit ID

Audience description

Audience ID (omit to create new)

Audience name (required on create)

The Brand Kit ID

Freeform markdown notes about the competitor (positioning, strengths, etc.)

Competitor domain (e.g. "example.com")

Competitor ID (omit to create new)

Competitor name (required on create)

Product line IDs to associate (must belong to this brand kit, at least one required)

The Brand Kit ID

Audience IDs to associate (must belong to this brand kit). Pass [] to clear.

Plain text content for the sample. On create, provide either content or url (not both).

Content type ID (required on create, must belong to this brand kit)

Content sample ID (omit to create new)

Region IDs to associate (must belong to this brand kit). Pass [] to clear.

URL of the content sample. On create, provide either url or content (not both).

The Brand Kit ID

Call-to-action text

Call-to-action URL

Header case style

Custom header case rules (when header_case is custom)

Content type ID (omit to create new)

Content type name (required on create)

URL of a content sample (only used on create)

Template outline

The Brand Kit ID

Custom variable ID (omit to create new)

Custom variable name (required on create)

Custom variable value (required on create, editable on update)

The Brand Kit ID

Publicly accessible URL to a font file (TTF, OTF, WOFF, WOFF2, or EOT). Use signed_id instead if the file was uploaded via create_brand_kit_direct_upload. Pass null or empty to leave the existing file unchanged.

Google Fonts URL for this font (e.g. https://fonts.google.com/specimen/Inter). Pass null or empty string to clear.

Font ID (omit to create new)

Font name, e.g. "Inter" or "Brand Heading Font" (required on create)

Signed blob ID returned by create_brand_kit_direct_upload after a direct upload. Preferred over file_url when the user has a local file. Pass null to leave the existing file unchanged.

Instructions for agents on when and how to use this font. Pass null or empty string to clear.

The Brand Kit ID

Height in pixels. Pass null to clear.

Logo size ID (omit to create new)

Logo size name, e.g. "Web Banner" or "Social Media Square" (required on create)

Instructions for agents on when and how to use this logo size. Pass null to clear.

Width in pixels. Pass null to clear.

The Brand Kit ID

Background color as a hex value (e.g. #ffffff). Pass null to clear.

Publicly accessible URL to a PNG or SVG image. Use signed_id instead if the file was uploaded via create_brand_kit_direct_upload. Pass null to leave the existing file unchanged.

Logo variant ID (omit to create new)

Logo variant name, e.g. "Primary Logo" or "Dark Background Logo" (required on create)

Signed blob ID returned by create_brand_kit_direct_upload after a direct upload. Preferred over file_url when the user has a local file. Pass null to leave the existing file unchanged.

Instructions for agents on when and how to use this logo, e.g. "Use on dark backgrounds only". Pass null to clear.

The Brand Kit ID

Palette ID (omit to create new)

The palette name, e.g. "Primary" (required on create)

The Brand Kit ID

Color ID (omit to create new)

Color name, e.g. "Brand Blue" (required on create)

The palette ID (required on create)

Instructions for agents on when and how to use this color

Hex color value, e.g. "#0055ff" (required on create)

The Brand Kit ID

Product line details

Product line ID (omit to create new)

Ideal customer profile

Product line name (required on create)

Product positioning

Product line URL

The Brand Kit ID

Region description

Flag icon name (e.g. flag-us, flag-gb). Pass empty string or null to clear.

Region ID (omit to create new)

Region name (required on create)

The Brand Kit ID

ID of the font this type size belongs to

Type size ID (omit to create new)

Line height as a decimal multiplier, e.g. 1.5.

Type size name, e.g. "H1 Display" or "Body Regular" (required on create)

Font size in pixels.

Instructions for agents on when and how to use this type size. Pass null or empty string to clear.

Font weight as an integer (100–900), e.g. 400 or 700.

The Brand Kit ID

What this rule applies to. Required on create; ignored on update.

Usage rule ID (omit to create new)

The usage rule text, e.g. "Use only on white backgrounds" (required on create)

The Brand Kit ID

Publicly accessible URL to a PNG, JPG, SVG, GIF, or WebP image. Use signed_id instead if the file was uploaded via create_brand_kit_direct_upload. Pass null to leave the existing file unchanged.

Visual example ID (omit to create new)

Optional URL to a live sample. Pass null to clear.

Signed blob ID returned by create_brand_kit_direct_upload after a direct upload. Preferred over file_url when the user has a local file. Pass null to leave the existing file unchanged.

Title of the visual example, e.g. "Dashboard Overview" (required on create)

Instructions for agents on when and how to use this visual example. Pass null to clear.

ID of the Visual Use Case to group this visual example under. Required on create. Use `manage_brand_kit_visual_use_case` to create or list visual use cases on this brand kit.

The Brand Kit ID

Visual use case ID (omit to create new)

Free-form instructions for when and how to apply the visual examples grouped under this visual use case. Pass null to clear.

Name of the visual use case, e.g. "Hero sections" (required on create)

The Brand Kit ID

Audience ID to scope this rule to (mutually exclusive with content_type_id and region_id). Only on create.

Content type ID to scope this rule to (mutually exclusive with audience_id and region_id). Only on create.

Writing rule ID (omit to create new)

Region ID to scope this rule to (mutually exclusive with content_type_id and audience_id). Only on create.

Writing rule text (required on create)

The Brand Kit ID to publish

The Playbook draft to publish.

Optional notes for the new version.

The Brand Kit ID to query analytics for

Metrics to calculate. Options: mention_rate (brand mention frequency, 0-100), positive_answer_rate (percentage of answers where your brand is positively mentioned, out of all answers where you have been mentioned and sentiment is determined; null when unavailable), share_of_voice (percentage of total mentions, 0-100), citation_rate (citation frequency, 0-100), citation_share (relative citation volume, 0-100), citation_count (total citations), sentiment_score (0-100, negative to positive; null when unavailable), average_position (ranking placement), answer_count (total responses), first_mention_rate (first position frequency, 0-100)

Filter by prompt type. Options: category (generic prompts - recommended for accurate visibility metrics), brand (prompts mentioning the brand). Defaults to category if not specified

Filter by country codes (ISO 3166-1 alpha-2)

Dimensions to group by (max 3).

End date (YYYY-MM-DD). Defaults to yesterday. Must be before today because today's data may still be processing and is incomplete — yesterday is used to ensure robust, complete data. Leave blank unless a specific date is requested.

Time granularity for aggregation. Default: total

Maximum rows to return (1-5000). Default: 100

Number of records to skip for pagination. Default: 0. Use with limit to page through large result sets.

Custom sort order (e.g., "citation_count DESC")

Filter by persona IDs

Filter by AI providers

Start date (YYYY-MM-DD). Default: 7 days ago

Filter by tags. A bare array of tag IDs matches ANY (IN). An object {"operator":"IN"|"HAS_ALL"|"NOT_IN","value":[ids]} selects the operator; HAS_ALL matches only items tagged with every listed tag; NOT_IN matches only items tagged with none of the listed tags.

Filter sentiment data by theme IDs. Only applies to sentiment_score metric.

Filter by topic IDs

The ID of the grid to read from.

The ID of the grid table (sheet) to read.

Optional list of column IDs to include. If omitted, all columns are returned.

Optional filters to apply.

Number of rows to return (1-100, default 50).

Row offset for pagination (default: 0). Use with limit to page through results.

Maximum number of characters per cell value (default 500, max 2000). Truncation is always applied; use read_grid_cell to read a full cell value.

The grid column ID (from the columns array returned by read_grid).

The ID of the grid.

The ID of the grid table (sheet).

The row ID (the __id field returned by read_grid).

The ID of the Playbook session containing the output.

A path under artifacts/external/ in the session volume. Provide exactly one selector.

The ID of a text-bearing event in the session. Provide exactly one selector.

Maximum characters to return (default 20000, max 200000).

Character offset to start reading from. Defaults to 0.

Campaign ID.

Opportunity IDs to reject. Required for v2; for v1 this rejects every pending item in each opportunity.

V1-only opportunity item IDs to reject. Use this for item-level rejection.

V1-only optional reason to store on rejected opportunity items.

The ID of the grid containing the rows to execute.

IDs of the grid rows to execute (max 50).

The ID of the grid table (sheet) containing the rows.

The ID of the Knowledge Base to search.

The search query. Use natural language to describe what you are looking for.

Number of results to return (1-20, default 5).

The type of content update to track

The page URL to track. The URL must belong to a brand_url or domain configured in one of the workspace's Brand Kits (use get_insights_settings to see domains). For example, if the Brand Kit domain is "example.com", URLs like "https://example.com/blog/post" will match.

The workspace ID to create the content update in

The Brand Kit ID owning the prompts to update.

Per-prompt assignment updates. Empty arrays clear a dimension; omitted or null dimensions remain unchanged.

The Brand Kit ID that owns the tag.

The tag ID to update.

Optional. New color from the platform palette.

Optional. New name for the tag. Must be unique within the Brand Kit (case-insensitive).

The Brand Kit ID to update

Description/overview of the brand

Name of the brand

URL of the brand website

The persona/voice used in brand writing

The tone of voice for brand content

The Brand Kit ID that owns the topic.

The topic ID to update.

Optional. New color from the platform palette.

Optional. New name for the topic. Must be unique within the Brand Kit.

The ID of the grid to write to.

The ID of the grid table (sheet) to write to.

'create' to add new rows, 'update' to modify existing rows (requires __id in each row).

Array of row objects. Keys are column titles, values are cell values. For update mode, include __id with the row ID.