> ## Documentation Index > Fetch the complete documentation index at: https://docs.otterly.ai/llms.txt > Use this file to discover all available pages before exploring further. # List recommendations for a brand report ## OpenAPI ````yaml https://data.otterly.ai/v1/openapi.json get /v1/reports/brand/{reportId}/recommendations openapi: 3.0.0 info: title: Otterly Public API version: 1.0.0 servers: - url: https://data.otterly.ai security: [] tags: - name: Engines - name: Workspaces - name: Brand Reports - name: Audits - name: Accounts paths: /v1/reports/brand/{reportId}/recommendations: get: tags: - Brand Reports summary: List recommendations for a brand report parameters: - schema: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 description: Brand report identifier. required: true description: Brand report identifier. name: reportId in: path - schema: type: string minLength: 1 description: >- Country code to filter recommendations by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom. example: us required: true description: >- Country code to filter recommendations by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom. name: country in: query - schema: type: string enum: - chatgpt - google - perplexity - copilot - google_ai_mode - gemini - claude description: Optional. Filter results to a single AI engine. example: chatgpt required: false description: Optional. Filter results to a single AI engine. name: engine in: query - schema: type: string minLength: 1 description: >- Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page. required: false description: >- Optional. Pagination cursor — pass back the `nextCursor` value from a previous response. Omit to fetch the first page. name: cursor in: query responses: '200': description: A list of recommendations for the brand report. content: application/json: schema: $ref: '#/components/schemas/PublicApiBrandReportRecommendationsList' '400': description: Validation failed. content: application/json: schema: $ref: '#/components/schemas/PublicApiValidationErrorResponse' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' '404': description: Report not found. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' security: - BearerAuth: [] components: schemas: PublicApiBrandReportRecommendationsList: type: object properties: items: type: array items: $ref: '#/components/schemas/PublicApiBrandReportRecommendationItem' paging: $ref: '#/components/schemas/PublicApiCursorPageInfo' required: - items - paging example: items: - id: 1072ee8791164402a29207d96bfb036ca43e85dd1c0678e8899cb0caa96f655c engine: chatgpt type: content_partnership_opportunities group: off_page priority: 6 score: 261 state: suggested data: url: >- https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/ title: Best Running Shoes of 2025, Tested & Reviewed domain: runnersworld.com domainCategory: News/Media mentionedCompetitors: - Nike - Asics - New Balance citations: 7 prompts: - promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: best running shoes 2025 country: us service: chatgpt type: content_partnership_opportunities paging: nextCursor: null hasMore: false PublicApiValidationErrorResponse: type: object properties: message: type: string target: type: string errors: type: array items: type: object properties: path: type: string message: type: string code: type: string required: - path - message - code required: - message - target - errors example: message: Validation failed target: query errors: - path: country message: Required code: invalid_type PublicApiErrorResponse: type: object properties: message: type: string required: - message example: message: Report not found PublicApiBrandReportRecommendationItem: type: object properties: id: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 engine: type: string type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Recommendation rule identifier. Determines the shape of `data`. checkerType: type: string enum: - prompts_sufficiency - prompt_diversity - crawlability - entity description: Higher-level checker that produced the recommendation. group: type: string enum: - general - off_page - on_page description: Recommendation surface group. priority: anyOf: - type: string - type: number score: type: number state: type: string enum: - suggested - todo - archived - removed status: type: string enum: - notStarted - inProgress - complete todoId: type: string data: anyOf: - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationPromptsCountData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationCompetitorsCountData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationPromptDiversityBrandedPromptsData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationPromptDiversityTofuData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationCrawlabilityCheckData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationBrandMentionCheckData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationContentPartnershipOpportunitiesData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationRedditThreadOpportunitiesData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationGetMentionedOnExistingMediaPressReleaseData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationCreateYoutubeVideosData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationCollaborateWithYoutubersData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationDriveConversationOnSocialMediaTopicsData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationImproveWikipediaPresenceData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationMediaPressReleaseSayThankYouData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationWritePressReleaseData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationCreateContentOnPageData - $ref: >- #/components/schemas/PublicApiBrandReportRecommendationImproveExistingContentData description: >- Recommendation payload. Shape is determined by the parent `type` field (e.g. `content_partnership_opportunities` → `PublicApiBrandReportRecommendationContentPartnershipOpportunitiesData`). May also include `country` and `service` keys describing the scope. required: - id example: id: 1072ee8791164402a29207d96bfb036ca43e85dd1c0678e8899cb0caa96f655c engine: chatgpt type: content_partnership_opportunities group: off_page priority: 6 score: 261 state: suggested data: url: https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/ title: Best Running Shoes of 2025, Tested & Reviewed domain: runnersworld.com domainCategory: News/Media mentionedCompetitors: - Nike - Asics - New Balance citations: 7 prompts: - promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: best running shoes 2025 country: us service: chatgpt type: content_partnership_opportunities PublicApiCursorPageInfo: type: object properties: nextCursor: type: string nullable: true hasMore: type: boolean required: - nextCursor - hasMore example: nextCursor: null hasMore: false PublicApiBrandReportRecommendationPromptsCountData: type: object properties: totalPrompts: type: number country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - totalPrompts additionalProperties: nullable: true example: totalPrompts: 6 country: us service: all type: prompts_count PublicApiBrandReportRecommendationCompetitorsCountData: type: object properties: totalCompetitors: type: number reportUuid: type: string country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - totalCompetitors - reportUuid additionalProperties: nullable: true example: totalCompetitors: 3 reportUuid: ai-report-uuid country: us service: all type: competitors_count PublicApiBrandReportRecommendationPromptDiversityBrandedPromptsData: type: object properties: totalPrompts: type: number brandedCount: type: number brandedPrompts: type: array items: type: object properties: promptId: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 prompt: type: string description: Optional. Full prompt text. required: - promptId additionalProperties: nullable: true country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - brandedCount - brandedPrompts additionalProperties: nullable: true example: totalPrompts: 87 brandedCount: 30 brandedPrompts: - promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: Acme reviews country: us service: all type: prompt_diversity_branded_prompts PublicApiBrandReportRecommendationPromptDiversityTofuData: type: object properties: totalPrompts: type: number tofuCount: type: number tofuPercentage: type: number country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - totalPrompts - tofuCount - tofuPercentage additionalProperties: nullable: true example: totalPrompts: 87 tofuCount: 25 tofuPercentage: 28.7 country: us service: all type: prompt_diversity_tofu PublicApiBrandReportRecommendationCrawlabilityCheckData: type: object properties: engines: type: array items: type: string country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - engines additionalProperties: nullable: true example: engines: - chatgpt - gemini country: us service: all type: crawlability_check PublicApiBrandReportRecommendationBrandMentionCheckData: type: object properties: engines: type: array items: type: string country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - engines additionalProperties: nullable: true example: engines: - chatgpt - gemini country: us service: chatgpt type: brand_mention_check PublicApiBrandReportRecommendationContentPartnershipOpportunitiesData: type: object properties: url: type: string title: type: string domain: type: string domainCategory: type: string mentionedCompetitors: type: array items: type: string citations: type: number prompts: type: array items: type: object properties: promptId: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 prompt: type: string description: Optional. Full prompt text. required: - promptId additionalProperties: nullable: true country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - url - domain - domainCategory - mentionedCompetitors - citations - prompts additionalProperties: nullable: true example: url: https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/ title: Best Running Shoes of 2025, Tested & Reviewed domain: runnersworld.com domainCategory: News/Media mentionedCompetitors: - Nike - Asics - New Balance citations: 7 prompts: - promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: best running shoes 2025 country: us service: chatgpt type: content_partnership_opportunities PublicApiBrandReportRecommendationRedditThreadOpportunitiesData: type: object properties: url: type: string title: type: string subreddit: type: string mentionedCompetitors: type: array items: type: string prompts: type: array items: type: object properties: promptId: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 prompt: type: string description: Optional. Full prompt text. required: - promptId additionalProperties: nullable: true citations: type: number country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - url - mentionedCompetitors - prompts - citations additionalProperties: nullable: true example: url: https://reddit.com/r/RunningShoeGeeks/comments/example title: Best running shoes 2025 megathread subreddit: RunningShoeGeeks mentionedCompetitors: - Nike - Asics prompts: - promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: best running shoes reddit citations: 4 country: us service: chatgpt type: reddit_thread_opportunities PublicApiBrandReportRecommendationGetMentionedOnExistingMediaPressReleaseData: type: object properties: url: type: string title: type: string domain: type: string mentionedCompetitors: type: array items: type: string competitorMentionsTotal: type: number citations: type: number prompts: type: array items: type: object properties: promptId: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 prompt: type: string description: Optional. Full prompt text. required: - promptId additionalProperties: nullable: true country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - url - domain - mentionedCompetitors - citations additionalProperties: nullable: true example: url: https://example.com/press/best-of-2025 title: Best running brands of 2025 domain: example.com mentionedCompetitors: - Nike competitorMentionsTotal: 3 citations: 2 prompts: - promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: best running brands country: us service: chatgpt type: get_mentioned_on_existing_media_press_release PublicApiBrandReportRecommendationCreateYoutubeVideosData: type: object properties: url: type: string title: type: string domain: type: string citations: type: number mentionedCompetitors: type: array items: type: string country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - url - domain - citations - mentionedCompetitors additionalProperties: nullable: true example: url: https://youtube.com/watch?v=example title: Top running shoes 2025 domain: youtube.com citations: 6 mentionedCompetitors: - Nike country: us service: chatgpt type: create_youtube_videos PublicApiBrandReportRecommendationCollaborateWithYoutubersData: type: object properties: url: type: string title: type: string channelTitle: type: string citations: type: number country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - url - citations additionalProperties: nullable: true example: url: https://youtube.com/@reviewer title: Running shoe reviewer channelTitle: ReviewerChannel citations: 5 country: us service: chatgpt type: collaborate_with_youtubers PublicApiBrandReportRecommendationDriveConversationOnSocialMediaTopicsData: type: object properties: url: type: string title: type: string domain: type: string citations: type: number mentionedCompetitors: type: array items: type: string country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - url - domain - citations - mentionedCompetitors additionalProperties: nullable: true example: url: https://x.com/influencer/status/example title: Best running shoes 2025 domain: x.com citations: 4 mentionedCompetitors: - Nike country: us service: chatgpt type: drive_conversation_on_social_media_topics PublicApiBrandReportRecommendationImproveWikipediaPresenceData: type: object properties: url: type: string title: type: string domain: type: string citations: type: number country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - url - domain - citations additionalProperties: nullable: true example: url: https://en.wikipedia.org/wiki/Running_shoe title: Running shoe domain: en.wikipedia.org citations: 3 country: us service: chatgpt type: improve_wikipedia_presence PublicApiBrandReportRecommendationMediaPressReleaseSayThankYouData: type: object properties: url: type: string title: type: string domain: type: string citations: type: number prompts: type: array items: type: object properties: promptId: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 prompt: type: string description: Optional. Full prompt text. required: - promptId additionalProperties: nullable: true country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - url - domain - citations additionalProperties: nullable: true example: url: https://example.com/article title: Acme makes the list domain: example.com citations: 4 country: us service: chatgpt type: media_press_release_say_thank_you PublicApiBrandReportRecommendationWritePressReleaseData: type: object properties: promptId: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 prompt: type: string competitorMentionsTotal: type: number headlineProposal: type: string country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - promptId - competitorMentionsTotal additionalProperties: nullable: true example: promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: new product launch competitorMentionsTotal: 6 headlineProposal: Acme launches new flagship shoe country: us service: chatgpt type: write_press_release PublicApiBrandReportRecommendationCreateContentOnPageData: type: object properties: promptId: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 prompt: type: string url: type: string title: type: string headlineSuggestion: type: string country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - promptId - url additionalProperties: nullable: true example: promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: compare Acme to BetaCorp url: https://acme.com/pages/pricing title: Acme pricing headlineSuggestion: How Acme pricing compares to BetaCorp country: us service: chatgpt type: create_content_on_page PublicApiBrandReportRecommendationImproveExistingContentData: type: object properties: promptId: type: string minLength: 1 example: 01HX7K2YV9D3M8N0G6Q5R4S3T2 prompt: type: string intent: type: string urls: type: array items: type: object properties: url: type: string title: type: string required: - url additionalProperties: nullable: true urlsWithCitations: type: array items: type: object properties: url: type: string title: type: string citations: type: number required: - url - citations additionalProperties: nullable: true country: type: string description: Optional. ISO country scope (e.g. `us`). service: type: string description: Optional. AI engine scope; `all` indicates cross-engine. type: type: string enum: - competitors_count - prompts_count - prompt_diversity_branded_prompts - prompt_diversity_tofu - crawlability_check - brand_mention_check - content_partnership_opportunities - reddit_thread_opportunities - get_mentioned_on_existing_media_press_release - create_youtube_videos - collaborate_with_youtubers - drive_conversation_on_social_media_topics - improve_wikipedia_presence - media_press_release_say_thank_you - write_press_release - create_content_on_page - improve_existing_content description: Optional. Duplicates the parent `type` for convenience. required: - promptId - intent - urls - urlsWithCitations additionalProperties: nullable: true example: promptId: 01HXP1DRTM5G8Z2N3KQ7VAW4PA prompt: why choose Acme intent: comparison urls: - url: https://acme.com/blog/post title: Why Acme urlsWithCitations: - url: https://acme.com/blog/post title: Why Acme citations: 2 country: us service: chatgpt type: improve_existing_content securitySchemes: BearerAuth: type: http scheme: bearer description: >- Provide your API key as a Bearer token: `Authorization: Bearer YOUR_API_KEY`. ````