Show export

curl --request GET \
  --url http://localhost:8080/api/v1/exports/{exportRequest} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8080/api/v1/exports/{exportRequest}', 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/{exportRequest}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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 := "http://localhost:8080/api/v1/exports/{exportRequest}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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("http://localhost:8080/api/v1/exports/{exportRequest}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": 200
}

{
  "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>"
}

GET

exports

{exportRequest}

Show export

curl --request GET \
  --url http://localhost:8080/api/v1/exports/{exportRequest} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8080/api/v1/exports/{exportRequest}', 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/{exportRequest}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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 := "http://localhost:8080/api/v1/exports/{exportRequest}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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("http://localhost:8080/api/v1/exports/{exportRequest}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": 200
}

{
  "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.

Path Parameters

exportRequest

string<uuid>

required

The export request ID

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

Getting Started

Configuration

Integrations

API Reference

More

Show export

Authorizations

Path Parameters

Response