Home API Documentation Reports API

About the Reports API

API Version: 1.9

The Reports API allows you to trigger and download reports in your NetworkCalc account.

Endpoints

https://networkcalc.com/api/reports/domain-reports/{domain_id}

Trigger an on-demand report to be run for a domain.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{domain_id}

(Optional) The unique ID of the domain.

Example: https://networkcalc.com/api/reports/domain-reports/123

Response Format

ReportTriggerResponse chevron_right

Response Codes

200
OK - Success.
401
INVALID_REQUEST - The authorization header is missing.
401
INVALID_GRANT - The given access token is expired or invalid.
400
NOT_GENERATED - The report was not generated due to some error.

Examples

Example 1
Run this in the API
cURL Example
curl -X POST https://networkcalc.com/api/reports/123 \
--header "Authorization: Bearer 2jdS83kfDdDfllHk"
content_copy
PowerShell Example
$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}
Invoke-RestMethod https://networkcalc.com/api/reports/123 -Method POST -Headers $headers | ConvertTo-Json
content_copy
Python Example
import requests
headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}
requests.post("https://networkcalc.com/api/reports/123", headers = headers).json()
content_copy
Response
{
  "status": "OK",
  "domain_id": "123",
  "report_url": "https://networkcalc.com/my/reports?highlight=bbbe76a8-d12f-4b24-a30d-0140d6d2e82b"
}
content_copy
https://networkcalc.com/api/reports/subdomain-reports/{subdomain_id}

Trigger an on-demand report to be run for a subdomain.

This endpoint requires authorization. Read about API authorization or see NetworkCalc Pro pricing.

Parameters

{subdomain_id}

(Optional) The unique ID of the subdomain.

Example: https://networkcalc.com/api/reports/subdomain-reports/456

Response Format

ReportTriggerResponse chevron_right

Response Codes

200
OK - Success.
401
INVALID_REQUEST - The authorization header is missing.
401
INVALID_GRANT - The given access token is expired or invalid.
400
NOT_GENERATED - The report was not generated due to some error.

Examples

Example 1
Run this in the API
cURL Example
curl -X POST https://networkcalc.com/api/reports/123 \
--header "Authorization: Bearer 2jdS83kfDdDfllHk"
content_copy
PowerShell Example
$headers = @{"Authorization"="Bearer 2jdS83kfDdDfllHk"}
Invoke-RestMethod https://networkcalc.com/api/reports/123 -Method POST -Headers $headers | ConvertTo-Json
content_copy
Python Example
import requests
headers = {"Authorization": "Bearer 2jdS83kfDdDfllHk"}
requests.post("https://networkcalc.com/api/reports/123", headers = headers).json()
content_copy
Response
{
  "status": "OK",
  "domain_id": "123",
  "report_url": "https://networkcalc.com/my/reports?highlight=bbbe76a8-d12f-4b24-a30d-0140d6d2e82b"
}
content_copy

Response Formats

{
  "status": "[string] The status of the request.",
  "domain_id": "[number] The unique ID of the domain.",
  "subdomain_id": "[number] The unique ID of the subdomain.",
  "report_url": "[string] A hyperlink to the report, where it can be downloaded in the NetworkCalc web interface."
}
content_copy