Reports API
nexmo · Company
The [Reports API](/reports/overview) enables you to request a report of activity for your Vonage account. Depending on your query pattern, you can choose from one of the two versions of the Reports API: asynchronous and synchronous. The asynchronous version is optimized for infrequent and large data queries (from several records to tens of millions). The synchronous version is optimized for frequent and periodic retrievals of small batches of data records (from one record to tens of thousand pe
Authentication
Sample Requests
List reports created by the specified account based on filtered provided.
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports?status=example&date_to=example&date_from=example&account_id=1"
import requests
params = {
"status": "example",
"date_to": "example",
"date_from": "example",
"account_id": "1"
}
response = requests.get(
"https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports');
url.searchParams.set('status', 'example');
url.searchParams.set('date_to', 'example');
url.searchParams.set('date_from', 'example');
url.searchParams.set('account_id', '1');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports")
q := baseURL.Query()
q.Set("status", "example")
q.Set("date_to", "example")
q.Set("date_from", "example")
q.Set("account_id", "1")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports")
uri.query = URI.encode_www_form({
"status" => "example",
"date_to" => "example",
"date_from" => "example",
"account_id" => "1"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports?" . http_build_query([
"status" => "example",
"date_to" => "example",
"date_from" => "example",
"account_id" => "1"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Fetch usage data synchronously
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/records?id=1&status=none&product=SMS&date_end=example&direction=inbound&account_id=1&date_start=example&include_message=false&show_concatenated=false"
import requests
params = {
"id": "1",
"status": "none",
"product": "SMS",
"date_end": "example",
"direction": "inbound",
"account_id": "1",
"date_start": "example",
"include_message": "false",
"show_concatenated": "false"
}
response = requests.get(
"https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/records",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/records');
url.searchParams.set('id', '1');
url.searchParams.set('status', 'none');
url.searchParams.set('product', 'SMS');
url.searchParams.set('date_end', 'example');
url.searchParams.set('direction', 'inbound');
url.searchParams.set('account_id', '1');
url.searchParams.set('date_start', 'example');
url.searchParams.set('include_message', 'false');
url.searchParams.set('show_concatenated', 'false');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/records")
q := baseURL.Query()
q.Set("id", "1")
q.Set("status", "none")
q.Set("product", "SMS")
q.Set("date_end", "example")
q.Set("direction", "inbound")
q.Set("account_id", "1")
q.Set("date_start", "example")
q.Set("include_message", "false")
q.Set("show_concatenated", "false")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/records")
uri.query = URI.encode_www_form({
"id" => "1",
"status" => "none",
"product" => "SMS",
"date_end" => "example",
"direction" => "inbound",
"account_id" => "1",
"date_start" => "example",
"include_message" => "false",
"show_concatenated" => "false"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/records?" . http_build_query([
"id" => "1",
"status" => "none",
"product" => "SMS",
"date_end" => "example",
"direction" => "inbound",
"account_id" => "1",
"date_start" => "example",
"include_message" => "false",
"show_concatenated" => "false"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Retrieve status and metadata about a requested report.
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/{report_id}"import requests
response = requests.get(
"https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/{report_id}",
)
print(response.json())const url = 'https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/{report_id}';
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
)
func main() {
targetURL := "https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/{report_id}"
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/{report_id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/reports/2.2.2/v2/reports/{report_id}";
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Reports API?
Reports API is a Company API. Developers commonly use company APIs for:
- enriching CRM records with company firmographics
- building lead-generation and prospecting tools
- verifying business identity and registration details
- monitoring competitors and market intelligence
- powering B2B data enrichment pipelines
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Reports API is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?