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

Catchpoint Systems Insights API

The Insights API from Catchpoint Systems — 4 operation(s) for insights.

Catchpoint Systems Insights API is one of 31 APIs that Catchpoint Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, /api.

4 operations 4 paths 15 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://io.catchpoint.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Catchpoint Systems Insights API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 4

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

Insights 4
GET
/v2/insights/{insightTokens}
Returns the insight details from tracepoints and indicators for tokens passed.
1 param → 200
GET
/v2/insights/insights
Returns the insight details from tracepoints and indicators for parameters passed.
3 params → 200
POST
/v2/insights
Create a new insight based on the PostData.
1 param body → 200
PATCH
/v2/insights/{insightType}/{insightToken}
Update an existing insight based on the request body.
3 params body → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightAPIModel (12 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightResponseModel] (6 properties), Catchpoint.Symphony.REST.Api.ApiUsageStatistics (6 properties), Microsoft.AspNetCore.JsonPatch.Operations.Operation (4 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.Enums.DomainStatus
integer
Catchpoint.Symphony.Enums.Test.InsightContentType
integer
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightAPIModel
object
12 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightResponseModel]
object
6 properties
Catchpoint.Symphony.Enums.Test.APIInsightType
integer
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.Enums.Test.InsightSourceType
integer
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightResponseModel
object
4 properties
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-systems-insights-api-openapi.yml Raw ↑

Other APIs Catchpoint Systems publishes across the network.

Catchpoint Systems Account API
Catchpoint Systems Alerts API
Catchpoint Systems ASNs API
Catchpoint Systems Assertions API
Catchpoint Systems CommandControl API
Catchpoint Systems Contacts API
Catchpoint Systems Credentials API
Catchpoint Systems Divisions API
Catchpoint Systems EndpointDevice API
Catchpoint Systems EndpointDevicePerformance API
Catchpoint Systems Folder API
Catchpoint Systems Instances API