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

Ntropy reports API

The reports API from Ntropy — 2 operation(s) for reports.

Ntropy reports API is one of 16 APIs that Ntropy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ntropy.com.

4 operations 2 paths 8 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ntropy.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ntropy reports API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 4

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

reports 4
POST
/v3/reports
Create a report
post-report-v-3-reports-post 1 param body → 200422
GET
/v3/reports
List all reports
get-reports-v-3-reports-get 6 params → 200422
GET
/v3/reports/{id}
Retrieve a report
get-report-v-3-reports-id-get 2 params → 200404422
DELETE
/v3/reports/{id}
Delete a report
delete-report-v-3-reports-id-delete 2 params → 204404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Report (7 properties), ValidationError (3 properties), ReportBase (3 properties), PagedResponse_Report_ (2 properties). Each schema is shown below with its type and property counts.

PagedResponse_Report_
object
2 properties 2 required
ValidationErrorLocItems
Report
object
7 properties 6 required
HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
ReportBase
object
3 properties 3 required
ReportStatus
string
Reports_delete_report_v3_reports__id__delete_Response_204
object
Empty response body

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-reports-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

Ntropy Account Holder API
Ntropy accountHolders API
Ntropy Bank statements API
Ntropy bankStatements API
Ntropy batches API
Ntropy categories API
Ntropy Enrichment API
Ntropy entities API
Ntropy Labels API
Ntropy Misc API
Ntropy personalization API
Ntropy recurrence API