Simplify management and monitoring with NetworkCalc Pro

About the Reports API

API Version: 1.9

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

Endpoints

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

Trigger a domain report

. 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 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.
POST
https://networkcalc.com/api/reports/subdomain-reports/{subdomain_id}

Trigger a subdomain report

. 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 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.

Response Formats

ReportTriggerResponse

{
  "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."
}