{ "openapi" : "3.0.1", "info" : { "title" : "Marketing Aeo", "description" : "Basepom for all HubSpot Projects", "version" : "2026-09-beta", "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Basic" } ], "paths" : { "/marketing/aeo/2026-09-beta/groups" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/marketing/aeo/2026-09-beta/groups_/marketing/aeo/2026-09-beta/groups", "parameters" : [ { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "businessUnitId", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null, "default" : "0" } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponsePublicGroupForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "marketing.aeo.write" ] }, { "oauth2" : [ "marketing.aeo.read" ] } ] } }, "/marketing/aeo/2026-09-beta/prompt-runs/{runUuid}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve prompt run", "description" : "Retrieve detailed information about a specific prompt run using its unique identifier. This endpoint provides insights into the run's state, associated AI model, citations, and mentions. It is useful for tracking the progress and results of a prompt run within the Answer Engine Visibility system.", "operationId" : "get-/marketing/aeo/2026-09-beta/prompt-runs/{runUuid}", "parameters" : [ { "name" : "runUuid", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicPromptRunDetail" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "marketing.aeo.write" ] }, { "oauth2" : [ "marketing.aeo.read" ] } ] } }, "/marketing/aeo/2026-09-beta/prompts" : { "get" : { "tags" : [ "Basic" ], "summary" : "List prompts", "description" : "Retrieve a list of prompts from the AnswerEngineVisibilityPublicApi. This endpoint allows you to filter and sort prompts based on various criteria, such as creation date and business unit. Use this endpoint to manage and view prompts efficiently.", "operationId" : "get-/marketing/aeo/2026-09-beta/prompts", "parameters" : [ { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "businessUnitId", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null, "default" : "0" } }, { "name" : "createdAfter", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "createdAt", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "createdBefore", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "groupFilterMode", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "groupId", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, { "name" : "language", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null } }, { "name" : "productId", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, { "name" : "sort", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponsePublicPromptForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "marketing.aeo.write" ] }, { "oauth2" : [ "marketing.aeo.read" ] } ] } }, "/marketing/aeo/2026-09-beta/prompts/{promptId}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve prompt", "description" : "Retrieve detailed information about a specific prompt, including its visibility settings, using the prompt's unique identifier. This endpoint is useful for obtaining insights into a prompt's configuration and its associated data within the specified date range.", "operationId" : "get-/marketing/aeo/2026-09-beta/prompts/{promptId}", "parameters" : [ { "name" : "promptId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "endDate", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "startDate", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicPromptWithVisibility" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "marketing.aeo.write" ] }, { "oauth2" : [ "marketing.aeo.read" ] } ] } }, "/marketing/aeo/2026-09-beta/prompts/{promptId}/runs" : { "get" : { "tags" : [ "Basic" ], "summary" : "List prompt runs", "description" : "Retrieve a list of runs for a specific prompt in the Answer Engine Visibility API. This endpoint allows you to filter runs based on creation dates and paginate through results. Useful for tracking the execution history of a specific prompt.", "operationId" : "get-/marketing/aeo/2026-09-beta/prompts/{promptId}/runs", "parameters" : [ { "name" : "promptId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "createdAfter", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "createdAt", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "createdBefore", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponsePublicPromptRunForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "marketing.aeo.write" ] }, { "oauth2" : [ "marketing.aeo.read" ] } ] } }, "/marketing/aeo/2026-09-beta/recommendations" : { "get" : { "tags" : [ "Basic" ], "summary" : "List recommendations", "description" : "Retrieve a list of recommendations from the AnswerEngineVisibilityPublicApi. This endpoint allows users to filter and sort recommendations based on various criteria such as prompt ID, status, and recommendation type. It supports pagination and sorting to efficiently manage large sets of data.", "operationId" : "get-/marketing/aeo/2026-09-beta/recommendations", "parameters" : [ { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "createdAfter", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "createdAt", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "createdBefore", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null } }, { "name" : "promptId", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "recommendationType", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "sort", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "status", "in" : "query", "description" : "", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponsePublicRecommendationForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "marketing.aeo.write" ] }, { "oauth2" : [ "marketing.aeo.read" ] } ] } }, "/marketing/aeo/2026-09-beta/recommendations/{recommendationId}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve recommendation", "description" : "Retrieve a specific recommendation by its unique identifier. This endpoint is useful for accessing detailed information about a particular recommendation within your HubSpot account.", "operationId" : "get-/marketing/aeo/2026-09-beta/recommendations/{recommendationId}", "parameters" : [ { "name" : "recommendationId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicRecommendation" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "marketing.aeo.write" ] }, { "oauth2" : [ "marketing.aeo.read" ] } ] } } }, "components" : { "schemas" : { "CollectionResponsePublicGroupForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicGroup" } } }, "example" : null }, "CollectionResponsePublicPromptForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "description" : "An array of PublicPrompt objects, representing the individual prompts in the collection.", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicPrompt" } } }, "example" : null }, "CollectionResponsePublicPromptRunForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "description" : "An array of public prompt run objects. Each object contains details about a specific prompt run.", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicPromptRun" } } }, "example" : null }, "CollectionResponsePublicRecommendationForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "description" : "An array of public recommendations. Each item in the array is a PublicRecommendation object.", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicRecommendation" } } }, "example" : null }, "Error" : { "required" : [ "category", "correlationId", "message" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The error category", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" }, "correlationId" : { "type" : "string", "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", "format" : "uuid", "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" }, "errors" : { "type" : "array", "description" : "further information about the error", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : "An error occurred" }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", "example" : { "message" : "Invalid input (details will vary based on the error)", "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", "category" : "VALIDATION_ERROR", "links" : { "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" } } }, "ErrorDetail" : { "required" : [ "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The status code associated with the error detail", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{missingScopes=[scope1, scope2]}" }, "in" : { "type" : "string", "description" : "The name of the field or parameter in which the error was found.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : null }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.", "example" : null }, "ForwardPaging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" } }, "description" : "Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.", "example" : null }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "A string token used as a cursor to retrieve the next set of results in a paginated response.", "example" : null }, "link" : { "type" : "string", "description" : "A URL string pointing to the next page of results in the paginated response.", "example" : null } }, "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response", "example" : null }, "PublicCitation" : { "required" : [ "title", "url" ], "type" : "object", "properties" : { "title" : { "type" : "string", "description" : "The title of the citation. It is a string that provides a brief description or name of the citation source.", "example" : null }, "url" : { "type" : "string", "description" : "The URL of the citation source. It is a string representing the web address where the citation can be found.", "example" : null } }, "example" : null }, "PublicGroup" : { "required" : [ "id", "languages", "name" ], "type" : "object", "properties" : { "id" : { "type" : "string", "example" : null }, "languages" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "name" : { "type" : "string", "example" : null } }, "example" : null }, "PublicPrompt" : { "required" : [ "aiAssistants", "businessUnitId", "createdAt", "groupIds", "icpIds", "id", "productIds", "prompt" ], "type" : "object", "properties" : { "aiAssistants" : { "type" : "array", "description" : "An array of AI assistants associated with the prompt.", "example" : null, "items" : { "type" : "string", "example" : null } }, "businessUnitId" : { "type" : "string", "description" : "The identifier for the business unit associated with the prompt.", "example" : null }, "buyingJourneyPhase" : { "type" : "string", "description" : "The phase of the buying journey that the prompt is associated with.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when the prompt was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "groupIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "icpIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "id" : { "type" : "string", "description" : "The unique identifier for the public prompt.", "example" : null }, "language" : { "type" : "string", "description" : "The language in which the prompt is written.", "example" : null }, "productIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "prompt" : { "type" : "string", "description" : "The text content of the prompt.", "example" : null } }, "example" : null }, "PublicPromptRun" : { "required" : [ "aiModel", "competitorMentions", "createdAt", "id", "ownedMentions", "promptId", "state", "totalCitations", "updatedAt" ], "type" : "object", "properties" : { "aiModel" : { "type" : "string", "description" : "The AI model used for this prompt run.", "example" : null }, "competitorMentions" : { "type" : "integer", "description" : "The number of mentions related to competitors during this prompt run.", "format" : "int32", "example" : null }, "completedAt" : { "type" : "string", "description" : "The date and time when this prompt run was completed, in ISO 8601 format.", "format" : "date-time", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when this prompt run was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for this prompt run.", "example" : null }, "ownedMentions" : { "type" : "integer", "description" : "The number of mentions owned by the user during this prompt run.", "format" : "int32", "example" : null }, "promptId" : { "type" : "string", "description" : "The unique identifier of the prompt associated with this run.", "example" : null }, "state" : { "type" : "string", "description" : "The current state of the prompt run.", "example" : null }, "totalCitations" : { "type" : "integer", "description" : "The total number of citations generated during this prompt run.", "format" : "int32", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when this prompt run was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null } }, "example" : null }, "PublicPromptRunDetail" : { "required" : [ "aiModel", "citations", "competitorMentions", "createdAt", "id", "ownedMentions", "promptId", "searchQueries", "state", "totalCitations", "updatedAt" ], "type" : "object", "properties" : { "aiModel" : { "type" : "string", "description" : "The AI model used for this prompt run.", "example" : null }, "citations" : { "type" : "array", "description" : "An array of citations that provide references or sources related to the prompt run.", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicCitation" } }, "competitorMentions" : { "type" : "integer", "description" : "The number of mentions related to competitors in the context of this prompt run.", "format" : "int32", "example" : null }, "completedAt" : { "type" : "string", "description" : "The date and time when the prompt run was completed, in ISO 8601 format.", "format" : "date-time", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when this prompt run was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for this prompt run.", "example" : null }, "ownedMentions" : { "type" : "integer", "description" : "The number of mentions owned by the entity running the prompt.", "format" : "int32", "example" : null }, "promptId" : { "type" : "string", "description" : "The unique identifier of the prompt associated with this run.", "example" : null }, "responseText" : { "type" : "string", "description" : "The text response generated by the prompt run.", "example" : null }, "searchQueries" : { "type" : "array", "description" : "An array of search queries used during the prompt run.", "example" : null, "items" : { "type" : "string", "example" : null } }, "state" : { "type" : "string", "description" : "The current state of the prompt run.", "example" : null }, "totalCitations" : { "type" : "integer", "description" : "The total number of citations associated with this prompt run.", "format" : "int32", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when this prompt run was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null } }, "example" : null }, "PublicPromptWithVisibility" : { "required" : [ "aiAssistants", "businessUnitId", "createdAt", "groupIds", "icpIds", "id", "productIds", "prompt" ], "type" : "object", "properties" : { "aiAssistants" : { "type" : "array", "description" : "An array of AI assistants associated with the prompt.", "example" : null, "items" : { "type" : "string", "example" : null } }, "businessUnitId" : { "type" : "string", "description" : "The identifier for the business unit associated with the prompt.", "example" : null }, "buyingJourneyPhase" : { "type" : "string", "description" : "The phase of the buying journey that the prompt is associated with.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when the prompt was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "groupIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "icpIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "id" : { "type" : "string", "description" : "The unique identifier for the prompt.", "example" : null }, "language" : { "type" : "string", "description" : "The language in which the prompt is written.", "example" : null }, "productIds" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "prompt" : { "type" : "string", "description" : "The text of the prompt.", "example" : null }, "visibility" : { "type" : "string", "description" : "An object representing the visibility settings of the prompt.", "example" : null } }, "example" : null }, "PublicRecommendation" : { "required" : [ "createdAt", "endDate", "id", "influencingCitations", "promptIds", "recommendationType", "startDate", "status" ], "type" : "object", "properties" : { "actionCategory" : { "type" : "string", "description" : "The category of action suggested by the recommendation. Valid values include 'CREATE_CONTENT', 'UPDATE_CONTENT', 'OUTREACH', and 'UPDATE_ROBOTS'.", "example" : null, "enum" : [ "CREATE_AD", "CREATE_CONTENT", "OUTREACH", "UPDATE_CONTENT", "UPDATE_ROBOTS" ] }, "actionChannel" : { "type" : "string", "description" : "The channel through which the recommended action should be taken. Valid values include 'YOUTUBE', 'LINKEDIN', 'REDDIT', 'AFFILIATE', 'PR', 'PEER', 'REVIEW_SITE', 'TECHNICAL_SEO', 'OWNED_CONTENT', 'LINKEDIN_ARTICLE', and 'LINKEDIN_POST'.", "example" : null, "enum" : [ "AFFILIATE", "CHAT_GPT_ADS", "CONTENT_SITE_AUDIT", "LINKEDIN", "LINKEDIN_ARTICLE", "LINKEDIN_POST", "OWNED_CONTENT", "PEER", "PR", "REDDIT", "REDDIT_SUBREDDIT", "REVIEW_SITE", "TECHNICAL_SITE_AUDIT", "YOUTUBE" ] }, "answerEngine" : { "type" : "string", "description" : "The answer engine used to generate the recommendation. Valid values include 'CHATGPT', 'GEMINI', and 'CLAUDE'.", "example" : null, "enum" : [ "CHATGPT", "CLAUDE", "GEMINI" ] }, "associatedContentUrl" : { "type" : "string", "description" : "The URL of the content associated with the recommendation.", "example" : null }, "contentTopic" : { "type" : "string", "description" : "A string representing the topic of the content related to the recommendation.", "example" : null }, "contentType" : { "type" : "string", "description" : "The type of content associated with the recommendation. Valid values include 'UNKNOWN', 'LISTICLE', 'COMPARISON', 'PRODUCT', 'BLOG', 'DOCUMENTATION', 'WIKI', 'NEWS', 'PR', 'RESEARCH', 'USER_REVIEW', 'SOCIAL', 'HOW_TO', 'GUIDE', 'EDUCATIONAL', 'HOMEPAGE', 'MULTIMEDIA', 'ARTICLE', and 'DOMAIN'.", "example" : null, "enum" : [ "ARTICLE", "BLOG", "COMPARISON", "DOCUMENTATION", "DOMAIN", "EDUCATIONAL", "GUIDE", "HOMEPAGE", "HOW_TO", "LISTICLE", "LISTICLE_COMPARISON", "LISTICLE_EDUCATIONAL", "MULTIMEDIA", "NEWS", "PR", "PRODUCT", "RESEARCH", "SOCIAL", "UNKNOWN", "USER_REVIEW", "WIKI" ] }, "createdAt" : { "type" : "string", "description" : "The date and time when the recommendation was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "domain" : { "type" : "string", "description" : "The domain associated with the recommendation.", "example" : null }, "endDate" : { "type" : "string", "description" : "The end date for the recommendation's relevance, formatted as a date.", "format" : "date", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the recommendation.", "example" : null }, "influencingCitations" : { "type" : "array", "description" : "An array of strings representing citations that influenced the recommendation.", "example" : null, "items" : { "type" : "string", "example" : null } }, "justification" : { "type" : "string", "description" : "The justification for why the recommendation was made.", "example" : null }, "priority" : { "type" : "string", "description" : "The priority level of the recommendation. Valid values include 'HIGH', 'MEDIUM', and 'LOW'.", "example" : null, "enum" : [ "HIGH", "LOW", "MEDIUM" ] }, "promptIds" : { "type" : "array", "description" : "An array of strings representing the IDs of prompts that influenced this recommendation.", "example" : null, "items" : { "type" : "string", "example" : null } }, "recommendationSummary" : { "type" : "string", "description" : "A summary of the recommendation provided.", "example" : null }, "recommendationType" : { "type" : "string", "description" : "The type of recommendation provided. Valid values include 'DOMAIN', 'URL', 'TECHNICAL', and 'CONTENT'.", "example" : null, "enum" : [ "ADS", "CONTENT", "DOMAIN", "TECHNICAL", "URL" ] }, "startDate" : { "type" : "string", "description" : "The start date for the recommendation's relevance, formatted as a date.", "format" : "date", "example" : null }, "status" : { "type" : "string", "description" : "The current status of the recommendation. Valid values include 'NEW', 'IN_PROGRESS', 'COMPLETED', 'ARCHIVED', 'FAILED', 'DISMISSED', and 'DRAFT_CREATED'.", "example" : null, "enum" : [ "ARCHIVED", "COMPLETED", "DISMISSED", "DRAFT_CREATED", "FAILED", "IN_PROGRESS", "NEW" ] }, "url" : { "type" : "string", "description" : "The URL associated with the recommendation.", "example" : null } }, "example" : null } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "example" : null } } } }, "securitySchemes" : { "developer_hapikey" : { "type" : "apiKey", "name" : "hapikey", "in" : "query" }, "oauth2" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "scopes" : { "marketing.aeo.read" : "", "marketing.aeo.write" : "" } } } }, "private_apps" : { "type" : "apiKey", "name" : "private-app", "in" : "header" }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }