Export Events - Intrace Documentation

GET

/

v1

/

events

/

export

Export Events

curl --request GET \
  --url https://api.corpus.intrace.ai/v1/events/export \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.corpus.intrace.ai/v1/events/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.corpus.intrace.ai/v1/events/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.corpus.intrace.ai/v1/events/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.corpus.intrace.ai/v1/events/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Headers

x-api-key

string | null

Corpus API key

Query Parameters

format

enum<string>

default:csv

Export format

Available options:

csv,

geojson,

json,

acled,

flat,

partner_ngmfa

country

string[]

Filter by country (repeatable)

event_type

string[]

Filter by event type (repeatable)

event_category

string[]

Filter by event category (repeatable)

event_subtype

string[]

Filter by event subtype (repeatable)

date_from

string<date> | null

date_to

string<date> | null

search

string | null

salience_score_min

number | null

Minimum salience score

salience_score_max

number | null

Maximum salience score

article_count_min

integer | null

Minimum article count

Required range: x >= 0

article_count_max

integer | null

Maximum article count

Required range: x >= 0

actor_count_min

integer | null

Minimum actor count

Required range: x >= 0

actor_count_max

integer | null

Maximum actor count

Required range: x >= 0

sort_by

string

default:event_date

Sort column

sort_order

enum<string>

default:desc

Sort direction

Available options:

asc,

desc

api_key

string | null

Corpus API key

Response

Successful Response

Export Events

curl --request GET \
  --url https://api.corpus.intrace.ai/v1/events/export \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.corpus.intrace.ai/v1/events/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.corpus.intrace.ai/v1/events/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.corpus.intrace.ai/v1/events/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.corpus.intrace.ai/v1/events/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}