Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Inductive Automation reports-info API

Reporting module information

Inductive Automation reports-info API is one of 88 APIs that Inductive Automation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include reports-info. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths. It is described by OpenAPI 3.0.3, at version 8.3.0.

Requests are made against 2 base URLs: http://{gateway-host}:{port}, https://{gateway-host}:{port}.

6 operations 6 paths 0 schemas 1 DELETE5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.3.0
Base URL
https://{gateway-host}:8088/api
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Inductive Automation reports-info API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Ignition-API-Token (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Time-limited API token. Obtain by posting credentials to the token endpoint. See /data/api/v1/token for details.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 DELETE, 5 GET. Each is listed below with its method, path, parameters, and response codes.

reports-info 6

Reporting module information

DELETE
/data/reporting/api/v1/cancel/{project}
Cancel A Report
cancel-a-report-delete 2 params → 200400401404
GET
/data/reporting/api/v1/reports/completed
Completed Reports
completed-reports-get 5 params → 200400401404
GET
/data/reporting/api/v1/reports/current
Currently Executing Reports
currently-executing-reports-get 5 params → 200400401404
GET
/data/reporting/api/v1/reports/published
Published Reports
published-reports-get 5 params → 200400401404
GET
/data/reporting/api/v1/reports/totals
Report Totals
report-totals-get → 200400401404
GET
/data/reporting/api/v1/reports/upcoming
Upcoming Reports
upcoming-reports-get 5 params → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inductive-automation-reports-info-api-openapi.yml Raw ↑

Other APIs Inductive Automation publishes across the network.

Ignition Gateway REST API
Inductive Automation access-control API
Inductive Automation agent-group API
Inductive Automation agent-management API
Inductive Automation alarm-journal-resources API
Inductive Automation alarm-notification-profile API
Inductive Automation api-token API
Inductive Automation audit API
Inductive Automation call-script API
Inductive Automation certificate-management API
Inductive Automation charts-info API
Inductive Automation client-pki-certificate-management API