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 TestPerformance API

The TestPerformance API from Catchpoint — 11 operation(s) for testperformance.

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

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

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

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

11 operations 11 paths 140 schemas 11 GET

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 TestPerformance API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 11

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

TestPerformance 11
GET
/v2/tests/records/waterfall/{testId}
Returns waterfall tokens based on test IDs.
4 params → 200
GET
/v2/tests/records/waterfall/data/{waterfallToken}
Returns the test waterfall data for a waterfall token.
2 params → 200
GET
/v2/tests/records/waterfall/screenshot/{waterfallToken}
Returns the test records waterfall screenshot based on the waterfall token.
2 params → 200
GET
/v2/tests/records/waterfall/filmstrip/{waterfallToken}
Returns the test records waterfall filmstrip based on the waterfall token.
2 params → 200
GET
/v2/tests/explorer/favoritechart
Returns the list of favorite charts from a client or a division.
→ 200
GET
/v2/tests/explorer/favoritechart/{favoriteChartId}
Returns the favorite chart details based on the favorite chart ID.
1 param → 200
GET
/v2/tests/explorer/favoritechart/data/{favoriteChartId}
Returns favorite chart data based on the ID and parameters provided.
5 params → 200
GET
/v2/tests/explorer/raw
Returns raw performance data for the provided Test IDs.
10 params → 200
GET
/v2/tests/explorer/aggregated
Returns aggregated performance data for the provided Test IDs.
11 params → 200
GET
/v2/tests/explorer/enumeration
Returns the test raw enumeration details for automation.
5 params → 200
GET
/v2/tests/explorer/favoritechart/defaultdata/{favoriteChartId}
Returns favorite chart default data set by the user when the favorite chart was created based on the ID.
1 param → 200

Schemas 140

The contract defines 140 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.WebRecordItem (38 properties), Catchpoint.Symphony.Response.NetworkGraphEdge (33 properties), Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordSslData (31 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.RecordResponseAPIModel (28 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.Enums.MobilePlaybackSourceType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordWebDataAPIModel
object
12 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.ContentTagAPIModel
object
2 properties
Catchpoint.Symphony.Enums.Metrics.RecordMetric
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordMqttData
object
4 properties
Catchpoint.Symphony.Enums.Dimension.BreakdownDimension
integer
Catchpoint.Symphony.Enums.Metrics.AnalyticsMetric
integer
Catchpoint.Symphony.ViewModels.InternetServiceTypeModel
object
9 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsApiResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsResponseRaw]]
object
6 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordTransactionStepAPIModel
object
2 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.ZoneAPIModel
object
2 properties
Catchpoint.Symphony.Response.ErrorCode
object
5 properties
Catchpoint.Symphony.Response.TraceRouteIpAddressLookup
object
8 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.WebErrorCodeItem
object
3 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.TestWaterfallTokenResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.FavoriteChart.FavoriteChartAPIModel
object
4 properties
Catchpoint.Symphony.Enums.Test.DisplayTestType
integer
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.WebRecordItem
object
38 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceLevelItemResponse
object
6 properties
Catchpoint.Symphony.ViewModels.CountryModel
object
5 properties
Catchpoint.Symphony.ViewModels.UriSlim
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordPageSpeedItem
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.HostDataAPIModel
object
2 properties
Catchpoint.Symphony.Enums.WinHttp.WinHttpMethod
integer
Catchpoint.Symphony.Response.NetworkIspOutageSummaryData
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordTransactionDataAPIModel
object
3 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordWebSocketItem
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.FavoriteChart.FavoriteChartTestDetailAPIModel
object
3 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsApiResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsResponseAggregated]
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceLevelItems
object
1 property
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordContentTagAPIModel
object
2 properties
Catchpoint.Symphony.Enums.Test.WifiModeType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordResponseAPIModel
object
28 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceLevelItem
object
8 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.TestWaterfallTokenResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationResponse
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordSshData
object
6 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.Enums.WinHttp.HttpVersionType
integer
Catchpoint.Symphony.ViewModels.InternetServiceDetailsModel
object
8 properties
Catchpoint.Symphony.Response.NetworkGraphTooltipOverrideSummaryData
object
7 properties
Catchpoint.Symphony.Orchestra.Response.PingProbeData
object
2 properties
Catchpoint.Symphony.Response.NetworkGraphPathMtuData
object
1 property
Catchpoint.Symphony.Response.NetworkIspOutageData
object
1 property
Catchpoint.Symphony.REST.Common.Response.v2_0.FavoriteChart.FavoriteChartAppDetailAPIModel
object
3 properties
Catchpoint.Symphony.Orchestra.Response.ECNSummaryData
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Performance.TestWaterfallTokenAPIModel
object
6 properties
Catchpoint.Symphony.Orchestra.Response.RecordMetricItem
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordContentZone
object
3 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordWebSocketData
object
9 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordSslData
object
31 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordSmtpData
object
5 properties
Catchpoint.Symphony.ViewModels.InternetServiceStackMapDataAssociationModel
object
7 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordTransactionStep
object
10 properties
Catchpoint.Symphony.Enums.SupportedTimeZone
integer
Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNodeReturnCodeGroup
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordHeader
object
2 properties
Catchpoint.Symphony.Orchestra.Response.RecordScriptErrorItem
object
5 properties
Catchpoint.Symphony.ViewModels.SonarPointsPerDay
object
2 properties
Catchpoint.Symphony.Response.NetworkGraphEdge
object
33 properties
Catchpoint.Symphony.Response.MplsHopSummaryData
object
4 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordNtpData
object
4 properties
Catchpoint.Symphony.Orchestra.Response.PingData
object
25 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Performance.ImageDataAPIModel
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordAdditionalMonitorData
object
5 properties
Catchpoint.Symphony.Enums.PlaybackSourceType
integer
Catchpoint.Symphony.Enums.Smartboard.WidgetSourceType
integer
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsApiResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsResponseAggregated]]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.MetricResponse
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationDetailResponse
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.FavoriteChart.FavoriteChartDetailsResponse
object
4 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.ImageDataItem
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsApiResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsResponseRaw]
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.FavoriteChart.FavoriteChartResponse]
object
6 properties
Catchpoint.Symphony.Enums.Sonar.GraphVertexType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordMetricItemAPIModel
object
5 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Nullable`1[System.Int32]]
object
2 properties
Catchpoint.Symphony.Enums.WebTagType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceData
object
10 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordFtpData
object
4 properties
Catchpoint.Symphony.Response.NetworkGraphPathMtuSummaryData
object
4 properties
Catchpoint.Symphony.ViewModels.InternetServiceModel
object
26 properties 2 required
Catchpoint.Symphony.ViewModels.RegionModel
object
4 properties
Catchpoint.Symphony.Response.NetworkGraphTooltipOverrideData
object
1 property
Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsResponseRaw
object
10 properties
Catchpoint.Symphony.Orchestra.Response.DebugProbeData
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordStreamingData
object
13 properties
Catchpoint.Symphony.Orchestra.Response.RecordDnsSecItem
object
2 properties
Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeAPIModel
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.FavoriteChart.FavoriteChartResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.WebRecordAPIModel
object
2 properties
Catchpoint.Symphony.Enums.MtuIndexType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordTcpData
object
5 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.TestWaterfallDataResponse
object
5 properties
Catchpoint.Symphony.Response.EcnSummaryData
object
2 properties
Catchpoint.Symphony.Enums.InternetServiceCategoryType
integer
Catchpoint.Symphony.ViewModels.LookupModel
object
6 properties
Catchpoint.Symphony.Orchestra.Response.TraceRouteData
object
16 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Insight.InsightResponse
object
3 properties
Catchpoint.Symphony.Response.GraphPath
object
11 properties
Catchpoint.Symphony.Enums.Test.PageSpeedRuleType
integer
Catchpoint.Symphony.Enums.Test.WebSocketTransferType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.HttpErrorCodeItem
object
3 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.TestWaterfallDataResponse]
object
6 properties
Catchpoint.Symphony.Enums.Test.DisplayMonitorType
integer
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsResponseAggregated
object
11 properties
Catchpoint.Symphony.ViewModels.ApdexThresholdModel
object
9 properties
Catchpoint.Symphony.Response.DscpSummaryData
object
2 properties
Catchpoint.Symphony.Response.NetworkGraphResponse
object
12 properties
Catchpoint.Symphony.Enums.InternetServiceIdentityType
integer
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.Orchestra.Response.IndicatorData
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.Performance.WaterfallTokenAPIModel
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.MetricModel
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.FavoriteChart.FavoriteChartDetailAPIModel
object
16 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.DimensionResponse
object
3 properties
Catchpoint.Symphony.Orchestra.Response.TracepointData
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.RecordHostDataAPIModel
object
2 properties
Catchpoint.Symphony.Enums.Test.WifiSecurityType
integer
Catchpoint.Symphony.Enums.ObjectType
integer
Catchpoint.Symphony.Enums.WinHttpErrorCode
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordWifiData
object
10 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordImapData
object
5 properties
Catchpoint.Symphony.Enums.RecordWebItemRequestType
integer
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.HeaderItem
object
2 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordTransactionData
object
2 properties
Catchpoint.Symphony.Enums.DomainStatus
integer
Catchpoint.Symphony.Response.NetworkGraphSummary
object
14 properties
Catchpoint.Symphony.Orchestra.Response.SyntheticRecords.RecordDnsTraceLevelItemQuery
object
11 properties
Catchpoint.Symphony.Response.FallbackReason
object
3 properties
Catchpoint.Symphony.Response.NetworkGraphVertex
object
11 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.AnalyticsResponseItem
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-testperformance-api-openapi.yml Raw ↑

Other APIs Catchpoint publishes across the network.

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