How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ObservePoint Reports API

The Reports API from ObservePoint — 6 operation(s) for reports.

ObservePoint Reports API is one of 65 APIs that ObservePoint 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 10 operations across 6 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0.

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

10 operations 6 paths 49 schemas 2 DELETE3 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.observepoint.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ObservePoint Reports API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (API_Key). By default, every request must be authenticated.

  • API_Key — Use the Authorization header in your requests with ObservePoint API key as header value. Example: Authorization: abc123...def456

Paths & Operations 10

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

Reports 10
POST
/v3/reports/grid/{gridEntityType}
Get Grid Data
getGridData 1 param body → 200400401403
GET
/v3/reports/grid/{gridEntityType}/schema
Get Grid Schema
getGridSchema 1 param → 200401403
POST
/v3/reports/grid/saved
Create Saved Report
createSavedReport body → 201400401403
GET
/v3/reports/grid/saved
List Saved Reports
getSavedReportsList 9 params → 200400401403
GET
/v3/reports/grid/saved/{id}
Get Saved Report
getSavedReportById 1 param → 200400401403404
PUT
/v3/reports/grid/saved/{id}
Update Saved Report
updateSavedReport 1 param body → 204400401403404
DELETE
/v3/reports/grid/saved/{id}
Delete Saved Report
deleteSavedReport 1 param → 204400401403404
POST
/v3/reports/grid/saved/{id}/favorites
Favorite Saved Report
addSavedReportToFavorites 1 param → 204400401403404
DELETE
/v3/reports/grid/saved/{id}/favorites
Unfavorite Saved Report
removeSavedReportFromFavorites 1 param → 204400401403404
POST
/v3/reports/grid/{gridEntityType}/exports
Start a grid data export
initiateGridDataExport 1 param body → 200400401403

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are GridApi_SavedReportResponseTrait (18 properties), GridApi_SchemaColumnDef (10 properties), GridApi_SavedReportRequestTrait (9 properties), GridApi_RequestDTO (6 properties). Each schema is shown below with its type and property counts.

GridApi_RequestDTO
object
Default Grid request body properties. Default behaviour: - if no page number is specified, default is 0 (the first results page) - if no size is specified, def…
6 properties
GridApi_Response_MetadataHeader_TotalItem
object
2 properties 2 required
GridApi_CreateSavedReportRequestDTO
GridApi_Response_MetadataHeader
object
Represents a single returned column in the grid. column matches one of columns from the "get grid metadata" response.
2 properties 1 required
GridApi_SavedReportVisibilityEnum
string
GridApi_PivotValue
object
Pivot value used to filter rows during aggregation. The value should be passed in the same format as received from the Grid API response. Type depends on the p…
GridApi_Request_ColumnExpression
GridApi_ConditionsMatchModeEnum
string
Specifies how to combine results of multiple conditions when determining if a row should be included in the result: - all - all conditions must be met; - any -…
DataDictionaryColumnOriginTypeEnum
string
GridApi_SavedReportRequestTrait
object
9 properties 2 required
GridApi_Request_SortByItem
object
Sorts the result by the specified column index. Default sorting order is ascending.
2 properties 1 required
GridExportFileFormatEnum
string
Format of the exported file
GridApi_GridEntityTypeEnum
string
LabelId
integer
ID of a label
GridApi_GetSchemaResponseDTO
object
1 property 1 required
GridApi_SavedReportResponseTrait
object
18 properties 11 required
GridApi_Request_ColumnExpression_ColumnId
object
3 properties 1 required
PaginationMetadata
object
5 properties 5 required
GridApi_DisplayMetadataDTO
object
Display metadata for the saved report
GridApi_Request_FilterBase
GridApi_ResponseRow
array
Each row represents a single run. The order of values corresponds to the order of columns in the headers. Nested objects are represented as array of fields.
GridApi_ExportRequestDTO
GridApi_AggregateFunctionEnum
string
See what aggregate functions are supported for each column in the supportedAggregateFunctions property of the GridApiSchemaColumnDef schema
GridApi_UpdateSavedReportRequestDTO
GridApi_FilterTrait_Negated
object
1 property
GridApi_VisualizationDefinitionDTO
object
JSON object containing FE definition for the visualization
GridApi_SavedReports_SortColumn
string
GridApi_SchemaColumnDef
object
10 properties 9 required
GridApi_ResponseDTO
object
2 properties 2 required
GridApi_Request_ColumnExpression_AggregateFunction
object
Represents an aggregate function with optional pivot setting applied to a column: - if aggregateFunction and aggregatedColumn are specified, pivotValuesColumnI…
4 properties
GridApi_Requests_FiltersDTO
object
2 properties
GridApi_SavedReportId
integer
ID of the saved report
GridApi_SavedReportDTO
GridApi_Request_TotalItem
object
2 properties 2 required
GridApi_EntityReference_FieldTypeEnum
string
name of field of the entity reference object
GridApi_ColumnId
string
Depends on the Grid type: - Audit Runs Grid: one of the AuditRunsGridColumnEnum values - Web Journey Runs Grid: one of the WebJourneyRunsGridColumnEnum values…
GridApi_VisualizationDTO
object
2 properties 2 required
ErrorModel
object
4 properties
CommonIterableResponseMetadata
object
Common metadata for iterable
1 property 1 required
GridExportResultDTO
object
1 property 1 required
DateAndTime
string
Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with the following additional restrictions: 1. An uppercase T must separat…
GridApi_Response_Metadata
Contains information about the response, such as pagination and returned columns/headers.
GridApi_ColumnTypeEnum
string
GridApi_LibraryMetadataDTO
object
Metadata required to show the saved report in the library
GridApi_GetSavedReportsListResponseDTO
object
2 properties 2 required
GridApi_FilterOperatorEnum
string
GridExportId
integer
Unique ID of a grid export
GridApi_CreateSavedReportResponseDTO
object
1 property 1 required
GridApi_GridEntityTypeInPathEnum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-reports-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account API
ObservePoint Account Triggered Alerts API
ObservePoint Account Usage Alerts API
ObservePoint Account Usage Export API
ObservePoint Account Usage V2 API
ObservePoint Action Set Action Rules API
ObservePoint Action Set Actions API
ObservePoint Action Sets API
ObservePoint Alert Export API
ObservePoint Alert Summary Report API
ObservePoint Alerts API
ObservePoint Audit Actions API
Where this information came from

This is an independent, third-party profile of ObservePoint Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.