External Relational ID

Generate a report

GET/selfService/report/byUserExtRelationId/{extRelationId}

Usage and limits report for the user for one period, priced in the given or default currency.

Request

Authorization
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer ********************
Path Params#
extRelationIdstring#required

A valid external relational ID as shown in VirtFusion.

Example: 1
Query Params#
periodstring#

A single period in the range of 0-24 (0 being the currently defined month in the self service settings | optional and will default to the current month if not defined).

Example: 0
currencystring#

A three letter currency code that is defined in the self service settings. (optional and will default to the user defined currency if not defined).

Example: USD
relStrboolean#

When true, the path value is matched against the user's relation string instead of the external relation ID.

Default: false
Example: true

Request Code Samples

curl --location --request GET 'https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json'
wget --quiet --output-document=- \
  --method=GET \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  'https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true'
http GET 'https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true' \
  'Authorization: Bearer <token>' \
  'Accept: application/json'
const response = await fetch("https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true", {
    method: "GET",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
    },
});

const data = await response.json();
console.log(response.status, data);
import axios from "axios";

const response = await axios({
    method: "get",
    url: "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
    },
});

console.log(response.status, response.data);
const https = require("https");

const req = https.request({
    hostname: "cp.domain.com",
    path: "/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true",
    method: "GET",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
    },
}, (res) => {
    let data = "";
    res.on("data", (chunk) => (data += chunk));
    res.on("end", () => console.log(res.statusCode, JSON.parse(data)));
});

req.on("error", (err) => console.error(err));
req.end();
import requests

url = "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true"
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
}

response = requests.request("GET", url, headers=headers)

print(response.status_code)
print(response.json())
import http.client
import json

conn = http.client.HTTPSConnection("cp.domain.com")
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
}

conn.request("GET", "/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true", None, headers)
response = conn.getresponse()

print(response.status)
print(json.loads(response.read()))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: application/json'
    ),
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
]);

echo $response->getStatusCode() . "\n";
echo $response->getBody();
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true"
    req, _ := http.NewRequest("GET", url, nil)
    req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Accept", "application/json")

    res, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer res.Body.Close()

    body, _ := io.ReadAll(res.Body)
    fmt.Println(res.StatusCode, string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true"))
            .header("Authorization", "Bearer <token>")
            .header("Accept", "application/json")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}
import okhttp3.*;

public class Main {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true")
            .method("GET", null)
            .addHeader("Authorization", "Bearer <token>")
            .addHeader("Accept", "application/json")
            .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println(response.code());
            System.out.println(response.body().string());
        }
    }
}
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(new HttpMethod("GET"), "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
require "net/http"
require "json"

uri = URI("https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"
request["Accept"] = "application/json"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.code
puts JSON.pretty_generate(JSON.parse(response.body))
import Foundation

var request = URLRequest(url: URL(string: "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true")!)
request.httpMethod = "GET"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Accept")

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else { print(error ?? "request failed"); return }
    print((response as! HTTPURLResponse).statusCode)
    print(String(data: data, encoding: .utf8) ?? "")
}
task.resume()
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use reqwest::blocking::Client;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let response = client
        .request(reqwest::Method::GET, "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .send()?;

    println!("{}", response.status());
    let json: serde_json::Value = response.json()?;
    println!("{}", serde_json::to_string_pretty(&json)?);
    Ok(())
}
// Cargo.toml: reqwest = { version = "0.12", features = ["json"] }, tokio = { version = "1", features = ["full"] }, serde_json = "1"
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let response = client
        .request(reqwest::Method::GET, "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .send()
        .await?;

    println!("{}", response.status());
    let json: serde_json::Value = response.json().await?;
    println!("{}", serde_json::to_string_pretty(&json)?);
    Ok(())
}
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request

fun main() {
    val client = OkHttpClient()
    val request = Request.Builder()
        .url("https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true")
        .method("GET", null)
        .addHeader("Authorization", "Bearer <token>")
        .addHeader("Accept", "application/json")
        .build()

    client.newCall(request).execute().use { response ->
        println(response.code)
        println(response.body?.string())
    }
}
// pubspec.yaml: http: ^1.2.0
import 'dart:convert';
import 'package:http/http.dart' as http;

Future<void> main() async {
  final request = http.Request('GET', Uri.parse('https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true'));
  request.headers['Authorization'] = 'Bearer <token>';
  request.headers['Accept'] = 'application/json';

  final response = await http.Response.fromStream(await request.send());
  print(response.statusCode);
  print(const JsonEncoder.withIndent('  ').convert(jsonDecode(response.body)));
}
#include <stdio.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (!curl) return 1;

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "Authorization: Bearer <token>");
    headers = curl_slist_append(headers, "Accept: application/json");

    curl_easy_setopt(curl, CURLOPT_URL, "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

    CURLcode result = curl_easy_perform(curl);
    if (result != CURLE_OK) fprintf(stderr, "%s\n", curl_easy_strerror(result));

    curl_slist_free_all(headers);
    curl_easy_cleanup(curl);
    return result == CURLE_OK ? 0 : 1;
}
$headers = @{
    Authorization = "Bearer <token>"
    Accept        = "application/json"
}

$response = Invoke-RestMethod -Uri "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true" -Method GET -Headers $headers
$response | ConvertTo-Json -Depth 10
GET /api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true HTTP/1.1
Host: cp.domain.com
Authorization: Bearer <token>
Accept: application/json

Responses

200

The user's usage and limits for the period. data.limits.packs enumerates the resource…

#
application/json

The user's usage and limits for the period. data.limits.packs enumerates the resource packs assigned to the user, each with its own limits, usage and traffic, preceded by a single entry with type hourly and id -1 when the user also has an hourly purchase profile. The list is empty when the user has neither.

object
dataobject#
fields
usageobject#
fields
serversarray[any]#
serversTotalobject#
fields
hoursboolean#
valueboolean#
tokensboolean#
hourConversionRateboolean#
monthlyTotalobject#
fields
hoursboolean#
valueboolean#
tokensboolean#
addonsTotalobject#
fields
hoursinteger#
valueinteger#
tokensboolean#
taxStatusinteger#
successboolean#
historystring#
breakdownboolean#
termstring#
previousTermstring#
nextTermstring#
periodobject#
fields
ymdstring#
startstring <date-time>#
endstring <date-time>#
showHourlyRateboolean#
showMonthlyRateboolean#
currencyobject#
fields
prefixstring#
suffixstring#
codestring#
currentValueinteger#
valueinteger#
defaultobject#
fields
prefixstring#
suffixstring#
codestring#
limitsobject#
fields
successboolean#
packsarray[any]#
Example
{
    "data": {
        "usage": {
            "servers": [],
            "serversTotal": {
                "hours": false,
                "value": false,
                "tokens": false
            },
            "hourConversionRate": false,
            "monthlyTotal": {
                "hours": false,
                "value": false,
                "tokens": false
            },
            "addonsTotal": {
                "hours": 0,
                "value": 0,
                "tokens": false
            },
            "taxStatus": 3,
            "success": false,
            "history": "0",
            "breakdown": true,
            "term": "January 2025",
            "previousTerm": "December 2024",
            "nextTerm": "February 2025",
            "period": {
                "ymd": "2025-01-01",
                "start": "2025-01-01T00:00:00+00:00",
                "end": "2025-01-31T00:00:00+00:00"
            },
            "showHourlyRate": false,
            "showMonthlyRate": false
        },
        "currency": {
            "prefix": "",
            "suffix": "",
            "code": "",
            "currentValue": 0,
            "value": 0,
            "default": {
                "prefix": "",
                "suffix": "",
                "code": ""
            }
        },
        "limits": {
            "success": true,
            "packs": []
        }
    }
}
401

The bearer token is missing, invalid, or expired. The response has no body.

#
No response body.
404

No user has this external relation ID.

#
application/json
msgstring#
Example
{
    "msg": "relation not found"
}
429

Too many requests. Either the token's requests per minute are used up (see the `X-RateL…

#
application/json

Too many requests. Either the token's requests per minute are used up (see the X-RateLimit-* headers) or the calling address has failed authentication 10 times in a minute (the body then includes retry_after_seconds). Retry-After gives the seconds to wait.

object
errorsarray[string]#
retry_after_secondsinteger#

Seconds to wait before retrying. Present on the failed-authentication limit only.

Response headers
Retry-Afterinteger

Seconds to wait before retrying.

X-RateLimit-Limitinteger

The token's requests per minute (token limit only).

X-RateLimit-Remaininginteger

Requests left in the current minute (token limit only).

X-RateLimit-Resetinteger

Unix timestamp at which the minute resets (token limit only).

Examples
{
    "errors": [
        "Too Many Requests"
    ]
}
{
    "errors": [
        "Too many authentication attempts. Try again later."
    ],
    "retry_after_seconds": 42
}