Get a report runner

curl --request GET \
  --url https://api.extole.io/v7/report-runners/{reportRunnerId} \
  --header 'Authorization: <api-key>'

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

fetch('https://api.extole.io/v7/report-runners/{reportRunnerId}', 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.extole.io/v7/report-runners/{reportRunnerId}",
  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: <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.extole.io/v7/report-runners/{reportRunnerId}"

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

	req.Header.Add("Authorization", "<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.extole.io/v7/report-runners/{reportRunnerId}")

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

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

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

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "created_date": "2025-10-24T02:00:00-07:00",
  "deliver_empty_reports_to_sftp": true,
  "enabled": true,
  "formats": [],
  "id": "<string>",
  "merging_configuration": {
    "formats": [],
    "sort_by": [
      "<string>"
    ],
    "unique_by": [
      "<string>"
    ]
  },
  "name": "<string>",
  "parameters": {},
  "pause_info": {
    "description": "<string>",
    "updated_date": "2025-10-24T09:00:00.000Z",
    "user_id": "<string>"
  },
  "paused": {
    "description": "<string>",
    "updated_date": "2025-10-24T09:00:00.000Z",
    "user_id": "<string>"
  },
  "report_name_pattern": "<string>",
  "report_type": "<string>",
  "report_type_name": "<string>",
  "scopes": [],
  "sftp_report_name_pattern": "<string>",
  "sftp_server_id": "<string>",
  "tags": [
    "<string>"
  ],
  "type": "REFRESHING",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "user_id": "<string>",
  "expiration_ms": 123
}

GET

report-runners

{reportRunnerId}

Get a report runner

curl --request GET \
  --url https://api.extole.io/v7/report-runners/{reportRunnerId} \
  --header 'Authorization: <api-key>'

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

fetch('https://api.extole.io/v7/report-runners/{reportRunnerId}', 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.extole.io/v7/report-runners/{reportRunnerId}",
  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: <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.extole.io/v7/report-runners/{reportRunnerId}"

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

	req.Header.Add("Authorization", "<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.extole.io/v7/report-runners/{reportRunnerId}")

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

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

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

{
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "created_date": "2025-10-24T02:00:00-07:00",
  "deliver_empty_reports_to_sftp": true,
  "enabled": true,
  "formats": [],
  "id": "<string>",
  "merging_configuration": {
    "formats": [],
    "sort_by": [
      "<string>"
    ],
    "unique_by": [
      "<string>"
    ]
  },
  "name": "<string>",
  "parameters": {},
  "pause_info": {
    "description": "<string>",
    "updated_date": "2025-10-24T09:00:00.000Z",
    "user_id": "<string>"
  },
  "paused": {
    "description": "<string>",
    "updated_date": "2025-10-24T09:00:00.000Z",
    "user_id": "<string>"
  },
  "report_name_pattern": "<string>",
  "report_type": "<string>",
  "report_type_name": "<string>",
  "scopes": [],
  "sftp_report_name_pattern": "<string>",
  "sftp_server_id": "<string>",
  "tags": [
    "<string>"
  ],
  "type": "REFRESHING",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "user_id": "<string>",
  "expiration_ms": 123
}

Authorizations

Authorization

string

header

required

Path Parameters

reportRunnerId

string

required

The Extole unique report runner identifier.

Response

Report runner.

REFRESHING
SCHEDULED

component_ids

string[]

required

component_references

object[]

required

Show child attributes

created_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

deliver_empty_reports_to_sftp

boolean

required

enabled

boolean

required

execution_policy

enum<string>

required

Available options:

AWAIT_DATA,

IMMEDIATE

formats

enum<string>[]

required

Available options:

CSV,

HEADLESS_CSV,

HEADLESS_PSV,

JSON,

JSONL,

PSV,

XLSX

string

required

read-only

merging_configuration

object

required

Show child attributes

name

string

required

parameters

object

required

Show child attributes

pause_info

object

required

Show child attributes

paused

object

required

Show child attributes

report_name_pattern

required

The report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.

report_type

string

required

report_type_name

string

required

scopes

enum<string>[]

required

Available options:

CLIENT_ADMIN,

CLIENT_SUPERUSER,

CONSUMER_PUBLIC

sftp_report_name_pattern

required

The sftp report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.

sftp_server_id

string | null

required

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Get a report runner

Authorizations

Path Parameters

Response