Create Report Run
curl --request POST \
--url https://api.goshippo.com/v2/reporting/runs \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"report_type": "<string>",
"interval": {
"start": 1704067200,
"end": 1706745600
},
"columns": [
"<string>"
],
"output_format": "csv_gzip",
"idempotency_key": "<string>"
}
'import requests
url = "https://api.goshippo.com/v2/reporting/runs"
payload = {
"report_type": "<string>",
"interval": {
"start": 1704067200,
"end": 1706745600
},
"columns": ["<string>"],
"output_format": "csv_gzip",
"idempotency_key": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
report_type: '<string>',
interval: {start: 1704067200, end: 1706745600},
columns: ['<string>'],
output_format: 'csv_gzip',
idempotency_key: '<string>'
})
};
fetch('https://api.goshippo.com/v2/reporting/runs', 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.goshippo.com/v2/reporting/runs",
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([
'report_type' => '<string>',
'interval' => [
'start' => 1704067200,
'end' => 1706745600
],
'columns' => [
'<string>'
],
'output_format' => 'csv_gzip',
'idempotency_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "https://api.goshippo.com/v2/reporting/runs"
payload := strings.NewReader("{\n \"report_type\": \"<string>\",\n \"interval\": {\n \"start\": 1704067200,\n \"end\": 1706745600\n },\n \"columns\": [\n \"<string>\"\n ],\n \"output_format\": \"csv_gzip\",\n \"idempotency_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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("https://api.goshippo.com/v2/reporting/runs")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"report_type\": \"<string>\",\n \"interval\": {\n \"start\": 1704067200,\n \"end\": 1706745600\n },\n \"columns\": [\n \"<string>\"\n ],\n \"output_format\": \"csv_gzip\",\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goshippo.com/v2/reporting/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"report_type\": \"<string>\",\n \"interval\": {\n \"start\": 1704067200,\n \"end\": 1706745600\n },\n \"columns\": [\n \"<string>\"\n ],\n \"output_format\": \"csv_gzip\",\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"report_type": "<string>",
"interval": {
"start": 1704067200,
"end": 1706745600
},
"columns": [
"<string>"
],
"output_format": "csv",
"created": 123,
"status": "QUEUED"
}Report Runs
Create Report Run
POST
/
v2
/
reporting
/
runs
Create Report Run
curl --request POST \
--url https://api.goshippo.com/v2/reporting/runs \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"report_type": "<string>",
"interval": {
"start": 1704067200,
"end": 1706745600
},
"columns": [
"<string>"
],
"output_format": "csv_gzip",
"idempotency_key": "<string>"
}
'import requests
url = "https://api.goshippo.com/v2/reporting/runs"
payload = {
"report_type": "<string>",
"interval": {
"start": 1704067200,
"end": 1706745600
},
"columns": ["<string>"],
"output_format": "csv_gzip",
"idempotency_key": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
report_type: '<string>',
interval: {start: 1704067200, end: 1706745600},
columns: ['<string>'],
output_format: 'csv_gzip',
idempotency_key: '<string>'
})
};
fetch('https://api.goshippo.com/v2/reporting/runs', 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.goshippo.com/v2/reporting/runs",
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([
'report_type' => '<string>',
'interval' => [
'start' => 1704067200,
'end' => 1706745600
],
'columns' => [
'<string>'
],
'output_format' => 'csv_gzip',
'idempotency_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "https://api.goshippo.com/v2/reporting/runs"
payload := strings.NewReader("{\n \"report_type\": \"<string>\",\n \"interval\": {\n \"start\": 1704067200,\n \"end\": 1706745600\n },\n \"columns\": [\n \"<string>\"\n ],\n \"output_format\": \"csv_gzip\",\n \"idempotency_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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("https://api.goshippo.com/v2/reporting/runs")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"report_type\": \"<string>\",\n \"interval\": {\n \"start\": 1704067200,\n \"end\": 1706745600\n },\n \"columns\": [\n \"<string>\"\n ],\n \"output_format\": \"csv_gzip\",\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goshippo.com/v2/reporting/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"report_type\": \"<string>\",\n \"interval\": {\n \"start\": 1704067200,\n \"end\": 1706745600\n },\n \"columns\": [\n \"<string>\"\n ],\n \"output_format\": \"csv_gzip\",\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"report_type": "<string>",
"interval": {
"start": 1704067200,
"end": 1706745600
},
"columns": [
"<string>"
],
"output_format": "csv",
"created": 123,
"status": "QUEUED"
}Authorizations
Shippo API token header, for example ShippoToken shippo_live_xxxx.
Body
application/json
Create an asynchronous report run. Select column names from the report type's available_columns.
Requested report interval in UTC epoch seconds.
Show child attributes
Show child attributes
Minimum array length:
1File format for the generated report.
Available options:
csv, csv_gzip, parquet Optional client key that makes create idempotent. Reusing the same key with the same request returns the original run (200); reusing it with a different request returns 409.
Required string length:
1 - 128Response
Idempotent replay of an existing report run.
- AcceptedReportRunResponse
- RunningReportRunResponse
- SucceededReportRunResponse
- FailedReportRunResponse
Run resource while queued for processing.
Report interval in UTC epoch seconds.
Show child attributes
Show child attributes
File format for the generated report.
Available options:
csv, csv_gzip, parquet Allowed value:
"QUEUED"Last modified on October 2, 2026
Was this page helpful?
⌘I