You need api key

Documentation Powered by Redocly

VitalFrog Performance API (Beta)

Download OpenAPI specification:Download

VitalFrog support: support@vitalfrog.com Terms of Service

This is the very basic api spec of the new VitalFrog performance api

performance reports

Create a new report

sd

Authorizations:
APIToken
Request Body schema: application/json
object (Countries)
mode
required
string
Default: "block_list"
Enum: "block_list" "allow_list"

How to handle the 'list'. If 'allow_list' than new countries is allowed, but the ones on the list. If 'block_list' then all countries are allowd.

required
Array of objects (Country)
Array
name
string
code
required
string
Component
string

Component of you software we are testing. Helps to later find cross repo problems.

Version
string

Version of you software we are testing. Helps for later tracing of problems.

performance_budgets_id
integer <int32>

What performance budget to use. If none configured the default VitalFrog performance budgets will be used

Array of objects (Device)

What devices to test. If not set falls back to testing two devices "desktop" & "mobile"

Array
name
required
string
Enum: "desktop" "mobile"
required
object (Target)
host
required
string
scheme
string
Default: "https"
required
ManualPathSelection (object)
Any of
mode
required
string^manual$
paths
required
Array of strings
object (HttpConfig)

Additional http request configurations

Array of objects (ExtraHeadersConfig)

Additional headers to configure on the request. Mostly used for authentication

Array
header
required
string
value
required
string
object (BasicAuth)

Basic auth credentials to configure

username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "countries": {
    },
  • "Component": "string",
  • "Version": "string",
  • "performance_budgets_id": 1,
  • "devices": [
    ],
  • "target": {
    },
  • "http": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": [
    ]
}

Get a all data of a single report

sd

path Parameters
uuid
required
string
Example: 1dea0c0e-e1e0-11ec-8fea-0242ac120002

asd

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "data": [
    ]
}

performance budgets

List all available performance budgets for this account

sd

Authorizations:
APIToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get single performance budget

sd

Authorizations:
APIToken
path Parameters
id
required
integer <int32>
Example: 1

asd

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "description": "Default VitalFrog performance budget",
  • "default": true,
  • "budgets": [
    ]
}