Skip to main content
GET
Share of Voice

Authorizations

Authorization
string
header
required

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

Query Parameters

query
string

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

topic
string

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

category
string

Story or event category denominator. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

country
string

Country denominator. Accepts an English name, ISO-2, or ISO-3. A Story matches when its own attributed countries include the value, or a linked Event is located there, or either linked Event actor originates there. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

region
enum<string>

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

Available options:
Africa,
Asia,
Middle East,
Northern Africa,
Western Africa,
Eastern Africa,
Middle Africa,
Southern Africa,
Europe,
Eastern Europe,
South Asia,
Southeast Asia,
East Asia,
Central Asia,
North America,
Central America,
Caribbean,
South America,
Oceania
continent
enum<string>

Continent restricting the Story/Event comparison denominator to its geographic coverage. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

Available options:
Africa,
Asia,
Europe,
North America,
South America,
Oceania
languages
string

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

source_set
string

Source denominator. all selects the complete served Story corpus in the requested window; otherwise pass one or more article domains such as reuters.com. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

entities
string

Entity identifiers. entity_id and entity are singular compatibility aliases. Also accepts: entity_id, entity. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

entity_query
string

Entity-name resolver input. entity_search, entity_terms, and numerator are aliases. Also accepts: entity_search, entity_terms, numerator. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

run_id
string

Materialized analytics run identifier returned by share_of_voice; selects that computation. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

denominator_hash
string

Denominator identity returned by a previous share_of_voice computation; reuses that exact comparison baseline. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

start_date
string<date>

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

end_date
string<date>

Last occurrence date. date_end is an alias. Also accepts: date_end. 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>

Anchor date of the comparison window, in YYYY-MM-DD. Note: validation is owned by the endpoint service because it depends on composed or cross-parameter state; the published error semantics above still apply.

days
string

Length in days of the trailing comparison window ending at the selected date. Also accepts: window. 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:25

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

Legacy number of source-article rows to skip; prefer the continuation cursor for new calls. 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

Share of Voice.

success
enum<boolean>
required
Available options:
true
data
object[]
required
status
string
required
start_date
string
required
end_date
string
required
entities
string[]
required
denominator
object
required
rows
object[]
required
methodology
object
required
resolved_entities
object[]
unresolved_terms
string[]
coverage
any
applied_filters
any