Get recommendation - Hrizn API Documentation

{ "data": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "suggestion_type": "<string>", "comparison_subtype": "<string>", "title": "<string>", "description": "<string>", "priority_score": 50, "metadata": {}, "suggested_article_type": "<string>", "created_at": "2023-11-07T05:31:56Z", "expires_at": "2023-11-07T05:31:56Z" } }

Authorizations

X-API-Key

string

header

required

Your Hrizn API key (prefix hzk_)

Path Parameters

string<uuid>

required

Content intelligence recommendation ID

Response

Recommendation details

data

object

Hide child attributes

data.id

string<uuid>

data.suggestion_type

string

Type of recommendation (e.g. missing_model_page, comparison_opportunity)

data.comparison_subtype

string | null

For comparison_opportunity type only: cross_brand, trim, or cross_category

data.title

string

Human-readable recommendation title

data.description

string

Detailed description of the content opportunity

data.priority_score

integer

Priority from 0-100. Higher scores indicate more impactful content opportunities.

Required range: 0 <= x <= 100

data.metadata

object

Type-specific data such as vehicle make/model/year, traffic estimates, competitor info. Shape varies by suggestion_type.

data.suggested_article_type

string | null

Recommended content type: basic, modellanding, comparison, salesevent, etc.

data.status

enum<string>

Available options:

active,

dismissed,

acted_on,

expired

data.created_at

string<date-time>

data.expires_at

string<date-time> | null

Documentation Index

Authorizations

Path Parameters

Response