Getting started
- Introduction
- Prerequisites
- Quickstart
Spark API
- Reference
- Chat
- Insights
Insights
Retrieve Generic Insight details
Returns the detailed, “explore” representation of a Spark insight (attributes, audiences, calculations, etc.).
GET
/
v1
/
spark-api
/
generic
/
insights
/
{id}
curl --request GET \
--url https://api.globalwebindex.com/v1/spark-api/generic/insights/{id} \
--header 'Authorization: <api-key>'
{
"insight": {
"id": "<string>",
"text": "<string>",
"metrics": [
"<string>"
],
"origins": {
"attributes": [
{
"attribute_key": {
"namespace_code": "<string>",
"question_code": "<string>",
"datapoint_code": "<string>",
"suffix_code": "<string>"
},
"generated_text": "<string>"
}
],
"audiences": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>"
}
],
"locations": [
"<string>"
],
"waves": [
"<string>"
],
"datasets": [
"<string>"
]
}
},
"attributes": [
{
"attribute_key": {
"namespace_code": "<string>",
"question_code": "<string>",
"datapoint_code": "<string>",
"suffix_code": "<string>"
},
"question_description": "<string>",
"question_name": "<string>",
"datapoint_name": "<string>",
"suffix_name": "<string>",
"generated_text": "<string>"
}
],
"audiences": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>"
}
],
"question_calculations": [
{
"question": {
"question_description": "<string>",
"question_name": "<string>"
},
"suffixes": "<string>",
"metric_priority": [
"<string>"
],
"calculations": [
{
"attribute_key": {
"namespace_code": "<string>",
"question_code": "<string>",
"datapoint_code": "<string>",
"suffix_code": "<string>"
},
"attribute": {
"attribute_key": {
"namespace_code": "<string>",
"question_code": "<string>",
"datapoint_code": "<string>",
"suffix_code": "<string>"
},
"question_description": "<string>",
"question_name": "<string>",
"datapoint_name": "<string>",
"suffix_name": "<string>",
"generated_text": "<string>"
},
"audience_id": "<string>",
"audience": {
"id": "<string>",
"title": "<string>",
"description": "<string>"
},
"percentage": 123,
"index": 123,
"sample": 123,
"size": 123
}
]
}
],
"location_groups": [
{
"group": "<string>",
"details": {
"description": "<string>",
"locations": [
{
"code": "<string>",
"name": "<string>"
}
]
}
}
],
"timeframe_groups": [
{
"group": "<string>",
"details": {
"description": "<string>",
"timeframes": [
{
"code": "<string>",
"name": "<string>"
}
]
}
}
],
"datasets": [
{
"title": "<string>",
"description": "<string>",
"url": "<string>"
}
]
}
Authorizations
Path Parameters
Insight unique identifier.
Response
200
application/json
Successful response
Complete “explore” view of a generic insight.
curl --request GET \
--url https://api.globalwebindex.com/v1/spark-api/generic/insights/{id} \
--header 'Authorization: <api-key>'
{
"insight": {
"id": "<string>",
"text": "<string>",
"metrics": [
"<string>"
],
"origins": {
"attributes": [
{
"attribute_key": {
"namespace_code": "<string>",
"question_code": "<string>",
"datapoint_code": "<string>",
"suffix_code": "<string>"
},
"generated_text": "<string>"
}
],
"audiences": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>"
}
],
"locations": [
"<string>"
],
"waves": [
"<string>"
],
"datasets": [
"<string>"
]
}
},
"attributes": [
{
"attribute_key": {
"namespace_code": "<string>",
"question_code": "<string>",
"datapoint_code": "<string>",
"suffix_code": "<string>"
},
"question_description": "<string>",
"question_name": "<string>",
"datapoint_name": "<string>",
"suffix_name": "<string>",
"generated_text": "<string>"
}
],
"audiences": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>"
}
],
"question_calculations": [
{
"question": {
"question_description": "<string>",
"question_name": "<string>"
},
"suffixes": "<string>",
"metric_priority": [
"<string>"
],
"calculations": [
{
"attribute_key": {
"namespace_code": "<string>",
"question_code": "<string>",
"datapoint_code": "<string>",
"suffix_code": "<string>"
},
"attribute": {
"attribute_key": {
"namespace_code": "<string>",
"question_code": "<string>",
"datapoint_code": "<string>",
"suffix_code": "<string>"
},
"question_description": "<string>",
"question_name": "<string>",
"datapoint_name": "<string>",
"suffix_name": "<string>",
"generated_text": "<string>"
},
"audience_id": "<string>",
"audience": {
"id": "<string>",
"title": "<string>",
"description": "<string>"
},
"percentage": 123,
"index": 123,
"sample": 123,
"size": 123
}
]
}
],
"location_groups": [
{
"group": "<string>",
"details": {
"description": "<string>",
"locations": [
{
"code": "<string>",
"name": "<string>"
}
]
}
}
],
"timeframe_groups": [
{
"group": "<string>",
"details": {
"description": "<string>",
"timeframes": [
{
"code": "<string>",
"name": "<string>"
}
]
}
}
],
"datasets": [
{
"title": "<string>",
"description": "<string>",
"url": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.