Skip to main content
GET
/
report
/
generate
/
{reportIdentifier}
Retrieve report generation status
curl --request GET \
  --url https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier} \
  --header 'X-Authorization: <api-key>'
import requests

url = "https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}"

headers = {"X-Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-Authorization': '<api-key>'}};

fetch('https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}', 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://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}",
  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-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://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}"

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

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

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}")
  .header("X-Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}")

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

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

response = http.request(request)
puts response.read_body
{
  "message": "Your report is being generated. Check for the report status after 30 seconds.",
  "retryAfter": 30,
  "_links": {
    "self": {
      "href": "https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}"
    }
  }
}
{
  "message": "Your report is ready",
  "_links": {
    "self": {
      "href": "https://operator-financial-reporting.staging.ezprk.dev/report/generate/{reportIdentifier}"
    },
    "report": {
      "href": "https://operator-financial-reporting.staging.ezprk.dev/report/{reportIdentifier}"
    }
  }
}

Authorizations

​
X-Authorization
string
header
required

For the header value, use the format: Bearer YOUR-JWT-TOKEN. You can get the token from the auth/v1 endpoint.

Path Parameters

​
reportIdentifier
string
required

The report identifier from the report generation initiation response

Response

Provides the current status of report generation. Includes self-reference links for in-progress report or error details for failed report.