HUhubspot
Basic

Retrieve recommendation

Changed on

Retrieve a specific recommendation by its unique identifier. This endpoint is useful for accessing detailed information about a particular recommendation within your HubSpot account.

get/marketing/aeo/2027-03-beta/recommendations/{recommendationId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/marketing/aeo/2027-03-beta/recommendations/{recommendationId}
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: marketing.aeo.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: marketing.aeo.read

Path parameters

recommendationIdstring required

Response

successful operation

actionCategory'CREATE_AD' | 'CREATE_CONTENT' | 'OUTREACH' | 'UPDATE_CONTENT' | 'UPDATE_ROBOTS'

The category of action suggested by the recommendation. Valid values include 'CREATE_CONTENT', 'UPDATE_CONTENT', 'OUTREACH', and 'UPDATE_ROBOTS'.

actionChannel'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'

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'.

answerEngine'CHATGPT' | 'CLAUDE' | 'GEMINI'

The answer engine used to generate the recommendation. Valid values include 'CHATGPT', 'GEMINI', and 'CLAUDE'.

associatedContentUrlstring

The URL of the content associated with the recommendation.

contentTopicstring

A string representing the topic of the content related to the recommendation.

contentType'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'

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'.

createdAtstring date-time required

The date and time when the recommendation was created, in ISO 8601 format.

domainstring

The domain associated with the recommendation.

endDatestring date required

The end date for the recommendation's relevance, formatted as a date.

idstring required

The unique identifier for the recommendation.

influencingCitationsstring[] required

An array of strings representing citations that influenced the recommendation.

justificationstring

The justification for why the recommendation was made.

priority'HIGH' | 'LOW' | 'MEDIUM'

The priority level of the recommendation. Valid values include 'HIGH', 'MEDIUM', and 'LOW'.

promptIdsstring[] required

An array of strings representing the IDs of prompts that influenced this recommendation.

recommendationSummarystring

A summary of the recommendation provided.

recommendationType'ADS' | 'CONTENT' | 'DOMAIN' | 'TECHNICAL' | 'URL' required

The type of recommendation provided. Valid values include 'DOMAIN', 'URL', 'TECHNICAL', and 'CONTENT'.

startDatestring date required

The start date for the recommendation's relevance, formatted as a date.

status'ARCHIVED' | 'COMPLETED' | 'DISMISSED' | 'DRAFT_CREATED' | 'FAILED' | 'IN_PROGRESS' | 'NEW' required

The current status of the recommendation. Valid values include 'NEW', 'IN_PROGRESS', 'COMPLETED', 'ARCHIVED', 'FAILED', 'DISMISSED', and 'DRAFT_CREATED'.

urlstring

The URL associated with the recommendation.

Changes

  • 2027-03-beta3e1835f1fe1dRevision changes
    • info

      the security scope marketing.aeo.write was added to the endpoint's security scheme oauth2

    • info

      the security scope marketing.aeo.read was removed from the endpoint's security scheme oauth2

  • 2027-03-beta53bae9def894Revision changes
    • info

      the security scope marketing.aeo.write was added to the endpoint's security scheme oauth2

    • info

      the security scope marketing.aeo.read was removed from the endpoint's security scheme oauth2