Catchpoint Systems Account API
The Account API from Catchpoint Systems — 1 operation(s) for account.
OpenAPI Specification
openapi: 3.0.1
info:
title: Catchpoint REST API v2.0 Account API
version: '2.0'
servers:
- url: /api
tags:
- name: Account
paths:
/v2/account/activity:
get:
tags:
- Account
summary: Returns Account Activity details by the parameters passed.
parameters:
- name: month
in: query
description: Account activity for the month
schema:
type: integer
format: int32
- name: year
in: query
description: Account activity for the year
schema:
type: integer
format: int32
- name: testName
in: query
description: Account activity for the Test Name
schema:
type: string
- name: networkTypes
in: query
description: Comma-separated list of Network Types (refer InternalLink[Test Enumeration Endpoint,operations-tag-Test,operations-Test-get_v2_tests_enumeration])
schema:
type: string
- name: testTypes
in: query
description: Comma-separated list of Test Types (refer InternalLink[Test Enumeration Endpoint,operations-tag-Test,operations-Test-get_v2_tests_enumeration])
schema:
type: string
- name: monitorTypes
in: query
description: Comma-separated list of Monitor Types (refer InternalLink[Test Enumeration Endpoint,operations-tag-Test,operations-Test-get_v2_tests_enumeration])
schema:
type: string
- name: divisionId
in: query
description: Account Activity for the Division ID
schema:
type: integer
format: int32
- name: productIds
in: query
description: Comma-separated list of Product IDs
schema:
type: string
- name: folderIds
in: query
description: Comma-separated list of Folder IDs
schema:
type: string
- name: pageNumber
in: query
description: Page number to return records from when the number of records exceeds pageSize
schema:
type: integer
format: int32
default: 1
- name: pageSize
in: query
description: Number of results per page. Maximum value is 100.
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.ActivityResponseModel]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.ActivityResponseModel]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.ActivityResponseModel]'
security:
- bearer: []
order: 1
components:
schemas:
Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.AccountActivityAPIModel:
type: object
properties:
id:
type: integer
format: int64
testId:
type: integer
format: int64
nullable: true
testType:
$ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.DisplayTestType'
divisionId:
type: integer
format: int32
nullable: true
productId:
type: integer
format: int32
nullable: true
folderId:
type: integer
format: int32
nullable: true
testName:
type: string
nullable: true
divisionName:
type: string
nullable: true
productName:
type: string
nullable: true
folderName:
type: string
nullable: true
displayMonitorType:
$ref: '#/components/schemas/Catchpoint.Symphony.Enums.Test.DisplayMonitorType'
testRuns:
type: integer
format: int32
verifyOnError:
type: integer
format: int32
extendedTimeoutFactor:
type: integer
format: int32
extendedDownloadFactor:
type: integer
format: int32
indicators:
type: integer
format: int32
tracepoints:
type: integer
format: int32
syntheticNetworkType:
$ref: '#/components/schemas/Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType'
captures:
type: integer
format: int32
filmstripsCount:
type: integer
format: int32
runsOrStepsWithHost:
type: integer
format: int32
runsOrStepsWithZone:
type: integer
format: int32
playTime:
type: integer
format: int32
averageRequests:
type: number
format: double
averageSteps:
type: number
format: double
points:
type: number
format: double
reportInterval:
type: string
format: date-time
nullable: true
isDebugOnError:
type: boolean
nullable: true
isInstantTest:
type: boolean
instantTestInitiatedFromApi:
type: boolean
additionalProperties: false
Catchpoint.Symphony.ViewModels.AccountActivity.BusinessContractModel:
type: object
properties:
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
monthlyUsedPoints:
type: number
format: double
monthlyContractedPoints:
type: number
format: double
monthlyBalance:
type: number
format: double
readOnly: true
contractUsedPoints:
type: number
format: double
contractContractedPoints:
type: number
format: double
contractBalance:
type: number
format: double
readOnly: true
averagePrice:
type: number
format: double
overagePrice:
type: number
format: double
additionalProperties: false
Catchpoint.Symphony.Enums.Test.DisplayTestType:
enum:
- id: 0
name: Web
- id: 1
name: TransactionLegacy
- id: 2
name: HtmlCode
- id: 3
name: Ftp
- id: 4
name: Tcp
- id: 5
name: Dns
- id: 6
name: Ping
- id: 7
name: Smtp
- id: 8
name: Udp
- id: 9
name: Api
- id: 10
name: Streaming
- id: 11
name: Ssh
- id: 12
name: TraceRoute
- id: 13
name: WebSocket
- id: 14
name: Ntp
- id: 15
name: Imap
- id: 16
name: Mqtt
- id: 17
name: Bulk
- id: 18
name: Ssl
- id: 19
name: Wifi
- id: 20
name: Bgp
- id: 21
name: NodeToNode
- id: 22
name: Bandwidth
- id: 23
name: WebPageTestWeb
- id: 24
name: WebPageTestTransaction
- id: 25
name: Playwright
- id: 26
name: Puppeteer
- id: 27
name: Transaction
type: integer
format: int32
? Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.ActivityResponseModel]
: type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.ActivityResponseModel'
messages:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
nullable: true
errors:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
nullable: true
completed:
type: boolean
readOnly: true
traceId:
type: string
nullable: true
usageLimits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics'
additionalProperties: false
Catchpoint.Symphony.REST.Api.ApiUsageStatistics:
type: object
properties:
clientId:
type: integer
format: int64
lastRequestTimestamp:
type: string
format: date-time
limits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit'
runs:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit'
exceededMessage:
type: string
nullable: true
readOnly: true
divisionUsageStatistics:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.DivisionUsageStatistics'
nullable: true
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.ActivityResponseModel:
type: object
properties:
activitySummary:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.AccountActivitySummaryAPIModel'
hasMore:
type: boolean
nullable: true
next:
type: string
nullable: true
previous:
type: string
nullable: true
additionalProperties: false
Catchpoint.Symphony.Enums.SyntheticLocation.SyntheticNetworkType:
enum:
- id: 0
name: Backbone
- id: 1
name: LastMile
- id: 2
name: Wireless
- id: 3
name: Private
- id: 4
name: Enterprise
- id: 5
name: PublicCloud
- id: 6
name: Any
- id: 7
name: Bgp
- id: 8
name: WebPageTest
- id: 9
name: Enterprise Branch
type: integer
format: int32
Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.AccountActivitySummaryAPIModel:
type: object
properties:
id:
type: integer
format: int64
billingStartDate:
type: string
format: date-time
nullable: true
uniqueTests:
type: integer
format: int32
nullable: true
pointsUsed:
type: number
format: double
dailyPointAverage:
type: number
format: double
totalTestRuns:
type: integer
format: int64
dailyTestRuns:
type: number
format: double
dailyPoints:
type: object
additionalProperties:
type: number
format: double
nullable: true
contractActivity:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.AccountActivity.BusinessContractModel'
nullable: true
accountInformation:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.AccountActivity.AccountActivityAPIModel'
nullable: true
hasMoreData:
type: boolean
additionalProperties: false
Catchpoint.Symphony.REST.Common.Models.InfoMessage:
type: object
properties:
information:
type: string
nullable: true
ignoredPath:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath'
nullable: true
additionalProperties: false
Catchpoint.Symphony.REST.Api.Limit:
type: object
properties:
minute:
type: integer
format: int32
hour:
type: integer
format: int32
day:
type: integer
format: int32
additionalProperties: false
Catchpoint.Symphony.REST.Api.ConsumerStatistics:
type: object
properties:
consumerId:
type: integer
format: int32
requestCount:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit'
maxPerDay:
type: integer
format: int32
nullable: true
additionalProperties: false
Catchpoint.Symphony.Enums.Test.DisplayMonitorType:
enum:
- id: 0
name: IE
- id: 1
name: RealUser
- id: 2
name: HTTP
- id: 3
name: Emulated
- id: 5
name: Mqtt
- id: 6
name: Imap
- id: 7
name: Ntp
- id: 8
name: Ping ICMP
- id: 9
name: Traceroute ICMP
- id: 10
name: DnsTrace
- id: 11
name: PingTcp
- id: 12
name: DnsExperience
- id: 13
name: DnsDirect
- id: 14
name: TraceRouteUdp
- id: 15
name: Tcp
- id: 16
name: Ftp
- id: 17
name: ApiSummary
- id: 18
name: Chrome
- id: 19
name: Playback
- id: 20
name: MobilePlayback
- id: 21
name: Smtp
- id: 22
name: TcpUdp
- id: 23
name: PingUdp
- id: 24
name: Streaming
- id: 25
name: Api
- id: 26
name: Mobile
- id: 28
name: Ssh
- id: 29
name: TraceRouteTcp
- id: 30
name: WebSocket
- id: 31
name: Ssl
- id: 32
name: Wifi
- id: 33
name: ShellScript
- id: 34
name: Bgp
- id: 35
name: TraceRouteSack
- id: 36
name: M-Lab Bandwidth
- id: 37
name: WebPageTest
- id: 39
name: Edge
- id: 40
name: Nprobe
- id: 41
name: BgpBasic
- id: 42
name: TracerouteQUIC
- id: 43
name: NProbeRFactor
type: integer
format: int32
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath:
type: object
properties:
ops:
type: string
nullable: true
path:
type: string
nullable: true
additionalProperties: false
Catchpoint.Symphony.ViewModels.MessageModel:
type: object
properties:
id:
type: string
nullable: true
message:
type: string
nullable: true
additionalProperties: false
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics:
type: object
properties:
divisionId:
type: integer
format: int32
consumerStatistics:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ConsumerStatistics'
nullable: true
additionalProperties: false
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT