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

Invendor Reports API

The Reports API from Invendor — 5 operation(s) for reports.

Invendor Reports API is one of 42 APIs that Invendor 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 and an API reference.

This API exposes 7 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against the base URL https://api.invendor.com.

7 operations 5 paths 11 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.invendor.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Invendor Reports API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 7

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

Reports 7
GET
/v1/Reports
Get user saved report states
User reports 1 param → 200400401403
POST
/v1/Reports
Saves (upserts) user defined custom report state
Save report 1 param body → 204400401403
GET
/v1/Reports/{viewId}
Returns the saved report view payload by viewId
Get report view 2 params → 200404400401403
GET
/v1/Reports/targets
Returns the users, groups and accounts available as report state targets for the calling user, based on their group's account relationships.
Available report targets 1 param → 200400401403
POST
/v1/Reports/userDefault
To set users default report state
Set default report 1 param body → 204400401403
PUT
/v1/Reports/{reportId}
Update saved report state
Update report 2 params body → 204400401403
DELETE
/v1/Reports/{reportId}
Delete saved report state
Delete report 2 params → 204400401403

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CreateReportRequest (6 properties), ProblemDetails (5 properties), UpdateReportRequest (5 properties), UserReportsResponse (5 properties). Each schema is shown below with its type and property counts.

ReportScope
integer
CreateReportRequest
object
6 properties
SetUserDefaultReportRequest
object
2 properties
UpdateReportRequest
object
5 properties
UserReportsResponse
object
5 properties
AvailableReportTargetsResponse
object
2 properties
Error
object
2 properties
ApiErrorResponse
object
1 property
ReportTargetAccount
object
2 properties
ReportTargetGroup
object
2 properties
ProblemDetails
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

invendor-reports-api-openapi.yml Raw ↑

Other APIs Invendor publishes across the network.

Invendor Accounts API
Invendor Auth API
Invendor Barcodes API
Invendor Consumption API
Invendor DataJobs API
Invendor Devices API
Invendor Dimensions API
Invendor DimensionValues API
Invendor Doors API
Invendor DynamicScanContent API
Invendor ExtendedProperties API
Invendor FlagTypes API