GET
Get Content Analysis

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Path Parameters

analysis_id
integer
required

A content analysis of the brand.

brand_id
integer
required

Response

Successful Response

created_at
string<date-time>
required
id
integer
required
kind
enum<string>
required

url: a page of a site. draft: a text or a file.

Available options:
url,
draft
result
AnalysisResult · object
required

Each part is null while its step did not run.

status
enum<string>
required

pending, running, success or failed.

Available options:
pending,
running,
success,
failed
step
string
required

The step that runs now, or the last step.

updated_at
string<date-time>
required
article_id
integer | null

The article of the brand that holds the text.

error
string | null
scenario_id
integer | null
title
string | null

The first heading of a draft.

topic_id
integer | null

The topic of the brand that the page answers.

topic_name
string | null
url
string | null