Queue export

curl --request POST \
  --url http://localhost:8080/api/v1/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_from": "2023-12-25",
  "date_to": "2023-12-25",
  "target": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "http://localhost:8080/api/v1/exports"

payload = {
    "date_from": "2023-12-25",
    "date_to": "2023-12-25",
    "target": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date_from: '2023-12-25',
    date_to: '2023-12-25',
    target: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('http://localhost:8080/api/v1/exports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/api/v1/exports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'date_from' => '2023-12-25',
    'date_to' => '2023-12-25',
    'target' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:8080/api/v1/exports"

	payload := strings.NewReader("{\n  \"date_from\": \"2023-12-25\",\n  \"date_to\": \"2023-12-25\",\n  \"target\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/exports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date_from\": \"2023-12-25\",\n  \"date_to\": \"2023-12-25\",\n  \"target\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/exports")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date_from\": \"2023-12-25\",\n  \"date_to\": \"2023-12-25\",\n  \"target\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "data": {
    "id": "<string>",
    "module": "<string>",
    "module_label": "Download Results",
    "format": "<string>",
    "status": "<string>",
    "filters": {},
    "row_count": 123,
    "failure_message": "<string>",
    "expires_at": "<string>",
    "download_url": "<string>",
    "created_at": "<string>"
  },
  "success": true,
  "code": 202,
  "message": "Export queued successfully."
}

{
  "success": false,
  "code": 401,
  "message": "<string>"
}

{
  "success": false,
  "code": 404,
  "message": "<string>"
}

{
  "success": false,
  "code": 405,
  "message": "<string>"
}

{
  "success": false,
  "code": 422,
  "message": "<string>",
  "errors": "<string>"
}

{
  "success": false,
  "code": 429,
  "message": "<string>"
}

{
  "success": false,
  "code": 500,
  "message": "<string>"
}

POST

exports

Queue export

curl --request POST \
  --url http://localhost:8080/api/v1/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_from": "2023-12-25",
  "date_to": "2023-12-25",
  "target": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "http://localhost:8080/api/v1/exports"

payload = {
    "date_from": "2023-12-25",
    "date_to": "2023-12-25",
    "target": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date_from: '2023-12-25',
    date_to: '2023-12-25',
    target: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('http://localhost:8080/api/v1/exports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/api/v1/exports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'date_from' => '2023-12-25',
    'date_to' => '2023-12-25',
    'target' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:8080/api/v1/exports"

	payload := strings.NewReader("{\n  \"date_from\": \"2023-12-25\",\n  \"date_to\": \"2023-12-25\",\n  \"target\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/exports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date_from\": \"2023-12-25\",\n  \"date_to\": \"2023-12-25\",\n  \"target\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/exports")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date_from\": \"2023-12-25\",\n  \"date_to\": \"2023-12-25\",\n  \"target\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "data": {
    "id": "<string>",
    "module": "<string>",
    "module_label": "Download Results",
    "format": "<string>",
    "status": "<string>",
    "filters": {},
    "row_count": 123,
    "failure_message": "<string>",
    "expires_at": "<string>",
    "download_url": "<string>",
    "created_at": "<string>"
  },
  "success": true,
  "code": 202,
  "message": "Export queued successfully."
}

{
  "success": false,
  "code": 401,
  "message": "<string>"
}

{
  "success": false,
  "code": 404,
  "message": "<string>"
}

{
  "success": false,
  "code": 405,
  "message": "<string>"
}

{
  "success": false,
  "code": 422,
  "message": "<string>",
  "errors": "<string>"
}

{
  "success": false,
  "code": 429,
  "message": "<string>"
}

{
  "success": false,
  "code": 500,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

module

enum<string>

required

Available options:

speed_download,

speed_upload,

speed_latency,

ping_result

format

enum<string>

required

Available options:

csv,

xlsx,

json

date_from

string<date>

required

date_to

string<date>

required

provider

enum<string> | null

Available options:

cloudflare,

librespeed,

netflix,

ookla,

null

target

string<uuid> | null

Response

ExportResource

data

ExportResource · object

required

Hide child attributes

data.id

string

required

data.module

string

required

data.module_label

enum<string>

required

Available options:

Download Results,

Upload Results,

Latency Results,

Ping Results

data.format

string

required

data.status

string

required

data.filters

object

required

Hide child attributes

data.filters.{key}

any

data.row_count

integer | null

required

data.failure_message

string | null

required

data.expires_at

string | null

required

data.download_url

string | null

required

data.created_at

string

required

success

boolean

required

code

integer

required

message

string

required

Allowed value: "Export queued successfully."

Getting Started

Configuration

Integrations

API Reference

More

Queue export

Authorizations

Body

Response