Skip to main content
GET
Atlas GPR — geopolitical risk vs a place’s own normal

Authorizations

Authorization
string
header
required

GDELT Cloud API key. Send as Authorization: Bearer gdelt_sk_....

Query Parameters

construction
enum<string>
default:own_coverage

Own-coverage series or the count-weighted world-corpus reference. The world-corpus reference uses the gpr variant/metric and attention weighting. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply. Full value list: https://docs.gdeltcloud.com/reference/enums#atlas_gpr_construction

Available options:
own_coverage,
world_corpus
variant
enum<string>

GPR lens. lens is the legacy alias. Defaults to gpr for world_corpus and events otherwise. Also accepts: lens. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply. Full value list: https://docs.gdeltcloud.com/reference/enums#atlas_gpr_variant

Available options:
events,
attention,
fullspectrum,
gpr
component
enum<string>
default:all

Component of the selected risk variant used for decomposition; use get_parameter_options with the variant to discover compatible components. Also accepts: decompose. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply. The legal values DEPEND ON variant: variant=events → all, threats, acts, verbal, material; variant=attention → all; variant=fullspectrum → all, threats, acts, verbal, material; variant=gpr → all, threats, acts. The enum is the union across every variant. The events lens (and its fullspectrum storage alias) carries all five; the gpr lens is built from the threat/act partition only, so verbal and material do not exist for it; the attention lens is a single undecomposed series, so all is its only component. Measured against prod: 6 of the 15 pairs a flat 5-value enum implies cannot return a row. Full value list: https://docs.gdeltcloud.com/reference/enums#atlas_gpr_component

Available options:
all,
threats,
acts,
verbal,
material
metric
enum<string>
default:gpr

Measure to read from the returned geopolitical-risk series; select it for the chosen construction and variant. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply. Full value list: https://docs.gdeltcloud.com/reference/enums#atlas_gpr_metric

Available options:
gpr,
pulse,
attention_share
weighting
enum<string>
default:attention

How country observations contribute to the regional or world aggregate; attention weights by coverage, equal gives countries equal weight. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply. Full value list: https://docs.gdeltcloud.com/reference/enums#atlas_weighting

Available options:
attention,
gdp
level
enum<string>
default:world

Spatial aggregation of the risk series: the world or a selected continent, region or country. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply. Full value list: https://docs.gdeltcloud.com/reference/enums#atlas_level

Available options:
world,
continent,
region,
country
geo
string

Place identifier appropriate for level; required when level is continent, region, or country and omitted for world. id is the legacy alias. Also accepts: id. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

window
integer
default:7

Trailing display window in days (1–30).

Required range: 1 <= x <= 30
date_start
string<date>

First observation date. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

date_end
string<date>

Last observation date. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

date
string<date>

One observation date; overrides the range. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

as_of
string<date>

Point-in-time vintage. realtime_start and vintage are aliases. Also accepts: realtime_start, vintage. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

limit
integer
default:100

Number of records to return on this page; pagination describes how to continue. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

Required range: 1 <= x <= 100
cursor
string

Continuation from pagination.next_cursor in the previous response. Keep the other filters unchanged; null means no next page. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

offset
integer

Number of records to skip before this page. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

Required range: x >= 0

Response

The index series, most recent first.

success
enum<boolean>
Available options:
true
series_id
string
Example:

"atlas.pulse.country.ukr.fullspectrum.all"

level
string
geo_id
string
methodology_version
string
Example:

"atlas-pulse-1.2.0"

construction
object | null

Present only on construction=world_corpus, describing the formula in force.

baseline
object | null

The frozen reference the returned rows were measured against.

coverage_floor
number
coverage_floor_basis
string
Example:

"single_day"

data
object[]
pagination
object