Get Content Analysis
curl --request GET \
--url https://app.backend.genezio.ai/customer/v1/brands/{brand_id}/content-analyses/{analysis_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.backend.genezio.ai/customer/v1/brands/{brand_id}/content-analyses/{analysis_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://app.backend.genezio.ai/customer/v1/brands/{brand_id}/content-analyses/{analysis_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"created_at": "2023-11-07T05:31:56Z",
"id": 123,
"kind": "url",
"result": {
"article_chunk_count": 0,
"brand_fit": {
"brand_name": "",
"competitors": [
"<string>"
],
"favorability": "moderate",
"favorable_sentences": [
{
"sentence": "<string>",
"why": ""
}
],
"headline": "",
"improvement_note": "",
"mentions_competitors": false,
"promotional_phrases": [
{
"phrase": "<string>",
"issue": ""
}
],
"promotional_risk": "low",
"takeaway": "",
"verdict": "moderate"
},
"content_type": {
"article_type": "<string>",
"article_type_explanation": "",
"article_type_label": "<string>",
"article_type_share": 0,
"takeaway": "",
"total_citations": 0,
"types": [
{
"count": 123,
"label": "<string>",
"share": 123,
"type": "<string>",
"example_urls": [
"<string>"
]
}
]
},
"days": 30,
"detected_scenario": {
"id": 123,
"text": ""
},
"detected_topic": {
"id": 123,
"name": ""
},
"domain_citations": {
"appearances": 0,
"brand_appearances": 0,
"brand_cited": 0,
"checked": false,
"cited": 0,
"cited_percentile": 0,
"cited_rate": 0,
"days": 30,
"domain": "",
"rank": 0,
"share_of_appearances": 0,
"takeaway": "",
"total_domains": 0
},
"findability": {
"blocked": [
"<string>"
],
"checked": false,
"crawlers": [
{
"allowed": true,
"category": "answer",
"engine": "<string>",
"name": "<string>"
}
],
"error": "",
"headline": "",
"reachable": true,
"robots_found": false,
"robots_url": "",
"takeaway": "",
"verdict": "strong"
},
"grounding": {
"capped": false,
"groundable_examples": [
{
"article_chunk_index": 123,
"content": "<string>",
"conversation_id": 123,
"score": 123,
"supporting_chunk": ""
}
],
"groundable_paragraphs": 0,
"groundable_pct": 0,
"n_conversations": 0,
"n_paragraphs": 0,
"similarity_threshold": 0,
"themes": [
{
"grounded": true,
"statement": "<string>",
"times_seen": 123,
"note": "",
"supporting_paragraph": "<string>"
}
]
},
"passage_competition": {
"actions": [
{
"asks": 0,
"how": "",
"priority": "next",
"question_ids": [
"<string>"
],
"title": "",
"why": ""
}
],
"answer_map": [
{
"question": "",
"score": 0,
"times_asked": 0
}
],
"asks_answered": 0,
"asks_total": 0,
"asks_unanswered": 0,
"checked": false,
"dead_passages": [
{
"n_questions": 0,
"question_ids": [
"<string>"
],
"score": 0,
"text": ""
}
],
"error": "",
"headline": "",
"mean_gap": 0,
"n_ahead": 0,
"n_article_passages": 0,
"n_behind": 0,
"n_close": 0,
"n_mapped_questions": 0,
"n_no_rival": 0,
"n_open": 0,
"n_pages_compared": 0,
"n_pages_crawled": 0,
"n_pages_from_cache": 0,
"n_pages_unavailable": 0,
"n_questions": 0,
"n_topic_questions": 0,
"passage_heat": [
{
"n_questions": 0,
"question_ids": [
"<string>"
],
"score": 0,
"text": ""
}
],
"pool_scope": "",
"questions": [
{
"cited_top": [
{
"domain": "",
"is_ours": false,
"score": 0,
"text": "",
"url": "",
"window": ""
}
],
"id": "",
"n_candidates": 0,
"n_cited_pages": 0,
"note": "",
"our_best": {
"domain": "",
"is_ours": false,
"score": 0,
"text": "",
"url": "",
"window": ""
},
"our_rank": 123,
"question": "",
"score_gap": 0,
"times_asked": 0,
"verdict": "no_rival",
"weak_words": [
{
"word": "<string>",
"cited": 0,
"ours": 0
}
]
}
],
"top_passages": [
{
"n_questions": 0,
"question_ids": [
"<string>"
],
"score": 0,
"text": ""
}
]
},
"readability": {
"grade": "",
"improvements": [
{
"example": "",
"issue": "",
"suggestion": "",
"why": ""
}
],
"reading_level": "",
"scores": {
"clarity": "",
"sentence_structure": "",
"structure_flow": "",
"tone_engagement": "",
"word_choice": ""
},
"strengths": [
"<string>"
],
"summary": ""
},
"report": {
"headline": "",
"opportunities": [
{
"question": "<string>",
"action": "",
"gap": "",
"priority": "medium"
}
],
"strengths": [
{
"question": "<string>",
"why": ""
}
]
},
"seo": {
"headline": "",
"signals": [
{
"key": "<string>",
"label": "<string>",
"rating": "good",
"value": "<string>",
"recommendation": ""
}
],
"takeaway": "",
"verdict": "moderate",
"word_count": 0
},
"sub_question_fit": {
"overall_match_rating": "unrelated",
"best_match": 0,
"best_question": "",
"covered_keywords": [
{
"asks": 0,
"n_questions": 0,
"score": 0,
"word": ""
}
],
"keyword_actions": [
{
"asks": 0,
"how": "",
"keywords": [
"<string>"
],
"title": "",
"why": ""
}
],
"missing_keywords": [
{
"asks": 0,
"n_questions": 0,
"score": 0,
"word": ""
}
],
"pool_scope": "",
"questions": [
{
"distinct_phrasings": 123,
"match": 123,
"match_rating": "unrelated",
"question": "<string>",
"times_asked": 123
}
],
"questions_matching": [
{
"match": 0,
"question": "",
"times_asked": 0
}
],
"questions_missing": [
{
"match": 0,
"question": "",
"times_asked": 0
}
],
"scaled": false,
"takeaway": "",
"word_heat": [
{
"scores": [
123
],
"text": "",
"words": [
"<string>"
]
}
]
},
"technical": {
"article": {
"author": false,
"date_modified": false,
"date_published": false,
"headline": false,
"present": false
},
"checked": false,
"error": "",
"has_faq": false,
"has_howto": false,
"has_product": false,
"has_review": false,
"headline": "",
"js_dependency": 0,
"load_ms": 0,
"main_content_share": 1,
"page_size_kb": 0,
"plain_words": 0,
"render_mode": "",
"rendered_words": 0,
"schemas": [
"<string>"
],
"script_count": 0,
"takeaway": "",
"verdict": "moderate"
},
"topic_coverage": {
"checked": false,
"headline": "",
"matched_threshold": 0,
"n_matched": 0,
"n_partial": 0,
"n_topics": 0,
"n_unmatched": 0,
"question_threshold": 0,
"takeaway": "",
"topics": [
{
"topic_id": 123,
"asks_covered": 0,
"asks_total": 0,
"best_match": 0,
"covered_share": 0,
"n_covered": 0,
"n_questions": 0,
"name": "",
"rating": "unmatched"
}
]
}
},
"status": "pending",
"step": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"article_id": 123,
"error": "<string>",
"scenario_id": 123,
"title": "<string>",
"topic_id": 123,
"topic_name": "<string>",
"url": "<string>"
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}Content analyses
Get a content analysis
One content analysis, with its result.
While status is pending or running, the result has the parts of
the steps that ended. Read it again until status is success or
failed.
GET
/
customer
/
v1
/
brands
/
{brand_id}
/
content-analyses
/
{analysis_id}
Get Content Analysis
curl --request GET \
--url https://app.backend.genezio.ai/customer/v1/brands/{brand_id}/content-analyses/{analysis_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.backend.genezio.ai/customer/v1/brands/{brand_id}/content-analyses/{analysis_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://app.backend.genezio.ai/customer/v1/brands/{brand_id}/content-analyses/{analysis_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"created_at": "2023-11-07T05:31:56Z",
"id": 123,
"kind": "url",
"result": {
"article_chunk_count": 0,
"brand_fit": {
"brand_name": "",
"competitors": [
"<string>"
],
"favorability": "moderate",
"favorable_sentences": [
{
"sentence": "<string>",
"why": ""
}
],
"headline": "",
"improvement_note": "",
"mentions_competitors": false,
"promotional_phrases": [
{
"phrase": "<string>",
"issue": ""
}
],
"promotional_risk": "low",
"takeaway": "",
"verdict": "moderate"
},
"content_type": {
"article_type": "<string>",
"article_type_explanation": "",
"article_type_label": "<string>",
"article_type_share": 0,
"takeaway": "",
"total_citations": 0,
"types": [
{
"count": 123,
"label": "<string>",
"share": 123,
"type": "<string>",
"example_urls": [
"<string>"
]
}
]
},
"days": 30,
"detected_scenario": {
"id": 123,
"text": ""
},
"detected_topic": {
"id": 123,
"name": ""
},
"domain_citations": {
"appearances": 0,
"brand_appearances": 0,
"brand_cited": 0,
"checked": false,
"cited": 0,
"cited_percentile": 0,
"cited_rate": 0,
"days": 30,
"domain": "",
"rank": 0,
"share_of_appearances": 0,
"takeaway": "",
"total_domains": 0
},
"findability": {
"blocked": [
"<string>"
],
"checked": false,
"crawlers": [
{
"allowed": true,
"category": "answer",
"engine": "<string>",
"name": "<string>"
}
],
"error": "",
"headline": "",
"reachable": true,
"robots_found": false,
"robots_url": "",
"takeaway": "",
"verdict": "strong"
},
"grounding": {
"capped": false,
"groundable_examples": [
{
"article_chunk_index": 123,
"content": "<string>",
"conversation_id": 123,
"score": 123,
"supporting_chunk": ""
}
],
"groundable_paragraphs": 0,
"groundable_pct": 0,
"n_conversations": 0,
"n_paragraphs": 0,
"similarity_threshold": 0,
"themes": [
{
"grounded": true,
"statement": "<string>",
"times_seen": 123,
"note": "",
"supporting_paragraph": "<string>"
}
]
},
"passage_competition": {
"actions": [
{
"asks": 0,
"how": "",
"priority": "next",
"question_ids": [
"<string>"
],
"title": "",
"why": ""
}
],
"answer_map": [
{
"question": "",
"score": 0,
"times_asked": 0
}
],
"asks_answered": 0,
"asks_total": 0,
"asks_unanswered": 0,
"checked": false,
"dead_passages": [
{
"n_questions": 0,
"question_ids": [
"<string>"
],
"score": 0,
"text": ""
}
],
"error": "",
"headline": "",
"mean_gap": 0,
"n_ahead": 0,
"n_article_passages": 0,
"n_behind": 0,
"n_close": 0,
"n_mapped_questions": 0,
"n_no_rival": 0,
"n_open": 0,
"n_pages_compared": 0,
"n_pages_crawled": 0,
"n_pages_from_cache": 0,
"n_pages_unavailable": 0,
"n_questions": 0,
"n_topic_questions": 0,
"passage_heat": [
{
"n_questions": 0,
"question_ids": [
"<string>"
],
"score": 0,
"text": ""
}
],
"pool_scope": "",
"questions": [
{
"cited_top": [
{
"domain": "",
"is_ours": false,
"score": 0,
"text": "",
"url": "",
"window": ""
}
],
"id": "",
"n_candidates": 0,
"n_cited_pages": 0,
"note": "",
"our_best": {
"domain": "",
"is_ours": false,
"score": 0,
"text": "",
"url": "",
"window": ""
},
"our_rank": 123,
"question": "",
"score_gap": 0,
"times_asked": 0,
"verdict": "no_rival",
"weak_words": [
{
"word": "<string>",
"cited": 0,
"ours": 0
}
]
}
],
"top_passages": [
{
"n_questions": 0,
"question_ids": [
"<string>"
],
"score": 0,
"text": ""
}
]
},
"readability": {
"grade": "",
"improvements": [
{
"example": "",
"issue": "",
"suggestion": "",
"why": ""
}
],
"reading_level": "",
"scores": {
"clarity": "",
"sentence_structure": "",
"structure_flow": "",
"tone_engagement": "",
"word_choice": ""
},
"strengths": [
"<string>"
],
"summary": ""
},
"report": {
"headline": "",
"opportunities": [
{
"question": "<string>",
"action": "",
"gap": "",
"priority": "medium"
}
],
"strengths": [
{
"question": "<string>",
"why": ""
}
]
},
"seo": {
"headline": "",
"signals": [
{
"key": "<string>",
"label": "<string>",
"rating": "good",
"value": "<string>",
"recommendation": ""
}
],
"takeaway": "",
"verdict": "moderate",
"word_count": 0
},
"sub_question_fit": {
"overall_match_rating": "unrelated",
"best_match": 0,
"best_question": "",
"covered_keywords": [
{
"asks": 0,
"n_questions": 0,
"score": 0,
"word": ""
}
],
"keyword_actions": [
{
"asks": 0,
"how": "",
"keywords": [
"<string>"
],
"title": "",
"why": ""
}
],
"missing_keywords": [
{
"asks": 0,
"n_questions": 0,
"score": 0,
"word": ""
}
],
"pool_scope": "",
"questions": [
{
"distinct_phrasings": 123,
"match": 123,
"match_rating": "unrelated",
"question": "<string>",
"times_asked": 123
}
],
"questions_matching": [
{
"match": 0,
"question": "",
"times_asked": 0
}
],
"questions_missing": [
{
"match": 0,
"question": "",
"times_asked": 0
}
],
"scaled": false,
"takeaway": "",
"word_heat": [
{
"scores": [
123
],
"text": "",
"words": [
"<string>"
]
}
]
},
"technical": {
"article": {
"author": false,
"date_modified": false,
"date_published": false,
"headline": false,
"present": false
},
"checked": false,
"error": "",
"has_faq": false,
"has_howto": false,
"has_product": false,
"has_review": false,
"headline": "",
"js_dependency": 0,
"load_ms": 0,
"main_content_share": 1,
"page_size_kb": 0,
"plain_words": 0,
"render_mode": "",
"rendered_words": 0,
"schemas": [
"<string>"
],
"script_count": 0,
"takeaway": "",
"verdict": "moderate"
},
"topic_coverage": {
"checked": false,
"headline": "",
"matched_threshold": 0,
"n_matched": 0,
"n_partial": 0,
"n_topics": 0,
"n_unmatched": 0,
"question_threshold": 0,
"takeaway": "",
"topics": [
{
"topic_id": 123,
"asks_covered": 0,
"asks_total": 0,
"best_match": 0,
"covered_share": 0,
"n_covered": 0,
"n_questions": 0,
"name": "",
"rating": "unmatched"
}
]
}
},
"status": "pending",
"step": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"article_id": 123,
"error": "<string>",
"scenario_id": 123,
"title": "<string>",
"topic_id": 123,
"topic_name": "<string>",
"url": "<string>"
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}{
"error": {
"code": "brand_access_denied",
"message": "This API key has no access to this brand",
"details": [
{
"field": "page_size",
"message": "Input should be less than or equal to 100"
}
],
"request_id": "4f3c2e1a-9b7d-4c1e-8f2a-1d3e5b7c9a0f"
}
}Authorizations
An API key of your account, from Settings > API Keys. It starts with gnz-.
Response
Successful Response
url: a page of a site. draft: a text or a file.
Available options:
url, draft Each part is null while its step did not run.
Show child attributes
Show child attributes
pending, running, success or failed.
Available options:
pending, running, success, failed The step that runs now, or the last step.
The article of the brand that holds the text.
The first heading of a draft.
The topic of the brand that the page answers.