Jump to

• Request
• Response

Get Synthetic Tests

get

/serviceapi/apm.dataserver/api/v1/synthetic/tests

Retrieve a list of Synthetic Tests. For more information see Synthetic Tests.

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): integer(int32)
  Maximum number of elements in the result set, useful for paging [default = all, max = 1000]. For more information see Paging.
• offset(optional): integer(int32)
  Offset into result set at which to start returning data, useful for paging [default = 0].
• orderBy(optional): string
  Comma-separated list of one or more attributes by which the result set is ordered [default = null]. For more information see Sorting. Use attribute or attribute:asc or attribute:desc. Valid attributes can be found by using Get resource metadata with metadataType = OrderBy and metadataQuery resource = /tests
• q(optional): string
  Query clause of one or more predicates to restrict the result set to those objects satisfying the clause [default = null]. For more information see Filtering. Use query like predicates, such as attribute<=value< code>. Multiple predicates should be parenthesized and joined by AND or OR. Valid attributes can be found by using Get resource metadata with metadataType = Filter and metadataQuery resource = /tests
• since: string
  Retrieve results from start of time period, format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (e.g. 2015-11-23T22:11:05.000Z). For more information see Since and Until Time Range.
• until: string
  Retrieve results until end of time period, format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Back to Top

Response

Supported Media Types

• application/json

200 Response

Completed successfully, list may be empty. See Status Codes for information about other possible HTTP response status codes.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SynTest
  Information about a synthetic test

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SynTest"
    }
}

Nested Schema : SynTest

Type: object

Information about a synthetic test

Show Source

• addresses(optional): array addresses
• adminFlow(optional): boolean
  Default Value: false
• agentVersionWarningForSA(optional): boolean
  Default Value: false
• ajaxCallCount(optional): integer(int64)
• alert(optional): string
• applicationMeId(optional): string
• applicationName(optional): string
• apps(optional): array apps
• authBasic(optional): boolean
  Default Value: false
• authNone(optional): boolean
  Default Value: false
• avgConnectTime(optional): number
• avgDownloadSize(optional): number
• avgFirstByteTime(optional): number
• avgRedirectTime(optional): number
• avgResponseTime(optional): number
• avgTotalContentLoadTime(optional): number
• avgTotalLoadTime(optional): number
• avgTotalWaitTime(optional): number
• avgTransferRate(optional): number
• baseUrl(optional): string
• beaconPools(optional): array beaconPools
• collectionFrequency(optional): integer(int32)
• completedCount(optional): integer(int64)
• completeTestInfo(optional): boolean
  Default Value: false
• errorPercentage(optional): number
• failureCount(optional): integer(int64)
• headerParams(optional): string
• icsInteg(optional): boolean
  Default Value: false
• icsIntegAdapter(optional): string
• id(optional): integer(int64)
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• locationCount(optional): integer(int32)
• locs(optional): array locs
• longKey(optional): string
• maxResponseTime(optional): integer(int64)
• meId(optional): string
• minResponseTime(optional): integer(int64)
• name: string
  Test name (required to create test, see @XSYNTESTS)
• noAgentWarning(optional): boolean
  Default Value: false
• opts(optional): array opts
• queryParams(optional): string
• queryTimeRange(optional): object TimeRange
• restWSAuthentication(optional): object RestWSAuthentication
  Information about authentication for Rest WS test type
• restWSRequestConfig(optional): object RestWSRequestConfig
• restWSResponseConfig(optional): object RestWSResponseConfig
  Information about reponse config for Rest WS test type
• serverTimeOut(optional): string
• status(optional): boolean
  Default Value: false
• successPercentage(optional): number
• tags(optional): array tags
• testLocationDetails(optional): array testLocationDetails
• type(optional): string
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "meId":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "baseUrl":{
            "type":"string"
        },
        "locationCount":{
            "type":"integer",
            "format":"int32"
        },
        "applicationName":{
            "type":"string"
        },
        "applicationMeId":{
            "type":"string"
        },
        "locs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "testLocationDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SyntheticLocation"
            }
        },
        "apps":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "opts":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "alert":{
            "type":"string"
        },
        "addresses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"boolean",
            "default":false
        },
        "maxResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "minResponseTime":{
            "type":"integer",
            "format":"int64"
        },
        "avgResponseTime":{
            "type":"number"
        },
        "avgTotalContentLoadTime":{
            "type":"number"
        },
        "avgTotalLoadTime":{
            "type":"number"
        },
        "avgTotalWaitTime":{
            "type":"number"
        },
        "avgConnectTime":{
            "type":"number"
        },
        "avgFirstByteTime":{
            "type":"number"
        },
        "avgRedirectTime":{
            "type":"number"
        },
        "avgTransferRate":{
            "type":"number"
        },
        "avgDownloadSize":{
            "type":"number"
        },
        "completedCount":{
            "type":"integer",
            "format":"int64"
        },
        "failureCount":{
            "type":"integer",
            "format":"int64"
        },
        "ajaxCallCount":{
            "type":"integer",
            "format":"int64"
        },
        "errorPercentage":{
            "type":"number"
        },
        "successPercentage":{
            "type":"number"
        },
        "beaconPools":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BeaconPool"
            }
        },
        "queryParams":{
            "type":"string"
        },
        "headerParams":{
            "type":"string"
        },
        "serverTimeOut":{
            "type":"string"
        },
        "restWSAuthentication":{
            "$ref":"#/definitions/RestWSAuthentication"
        },
        "restWSRequestConfig":{
            "$ref":"#/definitions/RestWSRequestConfig"
        },
        "restWSResponseConfig":{
            "$ref":"#/definitions/RestWSResponseConfig"
        },
        "icsInteg":{
            "type":"boolean",
            "default":false
        },
        "icsIntegAdapter":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "agentVersionWarningForSA":{
            "type":"boolean",
            "default":false
        },
        "noAgentWarning":{
            "type":"boolean",
            "default":false
        },
        "completeTestInfo":{
            "type":"boolean",
            "default":false
        },
        "adminFlow":{
            "type":"boolean",
            "default":false
        },
        "authBasic":{
            "type":"boolean",
            "default":false
        },
        "authNone":{
            "type":"boolean",
            "default":false
        },
        "collectionFrequency":{
            "type":"integer",
            "format":"int32"
        },
        "longKey":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Test name (required to create test, see @XSYNTESTS)"
        },
        "linkCollection":{
            "type":"array",
            "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "queryTimeRange":{
            "description":"Integer query time range used by server to run user query; see <a href='QP_Since_and_Until_Time_Range.html'>Since and Until Time Range</a> for more information",
            "$ref":"#/definitions/TimeRange"
        },
        "warnings":{
            "type":"array",
            "description":"Informational or Error messages",
            "items":{
                "$ref":"#/definitions/ErrorMessage"
            }
        }
    },
    "description":"Information about a synthetic test"
}

Nested Schema : addresses

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : apps

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : beaconPools

Type: array

Show Source

• Array of: object BeaconPool
  Information about beacon pool where the synthetic test will be run

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BeaconPool"
    }
}

Nested Schema : linkCollection

Type: array

See Links to Related Resources for more information

Show Source

• Array of: object Link
  Information about a Link to a resource

{
    "type":"array",
    "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : locs

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : opts

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : TimeRange

Type: object

Show Source

• sinceTime(optional): integer(int64)
  Results are returned *since* this timestamp
• timeInMinutes(optional): integer(int64)
• untilTime(optional): integer(int64)
  Results are returned *until* this timestamp

{
    "type":"object",
    "properties":{
        "timeInMinutes":{
            "type":"integer",
            "format":"int64"
        },
        "sinceTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *since* this timestamp"
        },
        "untilTime":{
            "type":"integer",
            "format":"int64",
            "description":"Results are returned *until* this timestamp"
        }
    }
}

Nested Schema : RestWSAuthentication

Type: object

Information about authentication for Rest WS test type

Show Source

• pwd(optional): string
• type(optional): string
• userName(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "pwd":{
            "type":"string"
        }
    },
    "description":"Information about authentication for Rest WS test type"
}

Nested Schema : RestWSRequestConfig

Type: object

Show Source

• methodBodyContent(optional): string
• methodType(optional): string
• mimeType(optional): string

{
    "type":"object",
    "properties":{
        "methodType":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "methodBodyContent":{
            "type":"string"
        }
    }
}

Nested Schema : RestWSResponseConfig

Type: object

Information about reponse config for Rest WS test type

Show Source

• expStatusCode(optional): string
• regExpToVerifyContent(optional): string
• verifyContent(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "expStatusCode":{
            "type":"string"
        },
        "verifyContent":{
            "type":"boolean",
            "default":false
        },
        "regExpToVerifyContent":{
            "type":"string"
        }
    },
    "description":"Information about reponse config for Rest WS test type"
}

Nested Schema : tags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : testLocationDetails

Type: array

Show Source

• Array of: object SyntheticLocation
  Information about the test locations

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SyntheticLocation"
    }
}

Nested Schema : warnings

Type: array

Informational or Error messages

Show Source

• Array of: object ErrorMessage
  An error message

{
    "type":"array",
    "description":"Informational or Error messages",
    "items":{
        "$ref":"#/definitions/ErrorMessage"
    }
}

Nested Schema : BeaconPool

Type: object

Information about beacon pool where the synthetic test will be run

Show Source

• agentCompatibleCount(optional): integer(int32)
• agentDownCount(optional): integer(int32)
• agentStatusDown(optional): boolean
  Default Value: false
• agentStatusNA(optional): boolean
  Default Value: false
• agentStatusNACount(optional): integer(int32)
• agentStatusUp(optional): boolean
  Default Value: false
• agentUnCompatibleCount(optional): integer(int32)
• agentUpCount(optional): integer(int32)
• agentWarningCount(optional): integer(int32)
• autoConfigUrl(optional): string
• badAgentVersion(optional): boolean
  Default Value: false
• badFirefoxVersion(optional): boolean
  Default Value: false
• badProxy(optional): boolean
  Default Value: false
• bpAgents(optional): array bpAgents
• bpBeacons(optional): array bpBeacons
• ccsWarningText(optional): string
• city(optional): string
• compatibleTests(optional): array compatibleTests
  Unique Items Required: true
• country(optional): string
• enabled(optional): boolean
  Default Value: false
• error(optional): boolean
  Default Value: false
• firefoxPath(optional): string
• hasOnlyCCSNodeTypes(optional): boolean
  Default Value: false
• id(optional): integer(int64)
• lattitude(optional): string
• linkCollection(optional): array linkCollection
  See Links to Related Resources for more information
• localHostAlias(optional): string
• location_display(optional): string
• location_internal(optional): string
• locationWarning(optional): boolean
  Default Value: false
• locationWarningList(optional): array locationWarningList
• longitude(optional): string
• longKey(optional): string
• maxCapacity(optional): string
• meId(optional): string
• name(optional): string
• noProxyFor(optional): string
• proxyHost(optional): string
• proxyPassword(optional): string
• proxyPort(optional): string
• proxyType(optional): string
• proxyUserName(optional): string
• queryTimeRange(optional): object TimeRange
• seleniumVncPool(optional): string
• showCCSWarning(optional): boolean
  Default Value: false
• statusPending(optional): boolean
  Default Value: false
• statusPendingCount(optional): integer(int32)
• success(optional): boolean
  Default Value: false
• type(optional): string
• validForHTTP(optional): boolean
  Default Value: false
• validForPageLoad(optional): boolean
  Default Value: false
• validForRestWS(optional): boolean
  Default Value: false
• validForScriptedActions(optional): boolean
  Default Value: false
• warning(optional): boolean
  Default Value: false
• warnings(optional): array warnings
  Informational or Error messages

{
    "type":"object",
    "properties":{
        "meId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "location_display":{
            "type":"string"
        },
        "location_internal":{
            "type":"string"
        },
        "longitude":{
            "type":"string"
        },
        "lattitude":{
            "type":"string"
        },
        "enabled":{
            "type":"boolean",
            "default":false
        },
        "city":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "proxyHost":{
            "type":"string"
        },
        "proxyPort":{
            "type":"string"
        },
        "proxyUserName":{
            "type":"string"
        },
        "proxyPassword":{
            "type":"string"
        },
        "proxyType":{
            "type":"string"
        },
        "noProxyFor":{
            "type":"string"
        },
        "autoConfigUrl":{
            "type":"string"
        },
        "bpBeacons":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "bpAgents":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "maxCapacity":{
            "type":"string"
        },
        "seleniumVncPool":{
            "type":"string"
        },
        "firefoxPath":{
            "type":"string"
        },
        "localHostAlias":{
            "type":"string"
        },
        "success":{
            "type":"boolean",
            "default":false
        },
        "error":{
            "type":"boolean",
            "default":false
        },
        "warning":{
            "type":"boolean",
            "default":false
        },
        "statusPending":{
            "type":"boolean",
            "default":false
        },
        "badAgentVersion":{
            "type":"boolean",
            "default":false
        },
        "badFirefoxVersion":{
            "type":"boolean",
            "default":false
        },
        "badProxy":{
            "type":"boolean",
            "default":false
        },
        "agentCompatibleCount":{
            "type":"integer",
            "format":"int32"
        },
        "agentUnCompatibleCount":{
            "type":"integer",
            "format":"int32"
        },
        "agentWarningCount":{
            "type":"integer",
            "format":"int32"
        },
        "locationWarning":{
            "type":"boolean",
            "default":false
        },
        "locationWarningList":{
            "type":"array",
            "items":{
                "type":"boolean"
            }
        },
        "agentUpCount":{
            "type":"integer",
            "format":"int32"
        },
        "agentStatusUp":{
            "type":"boolean",
            "default":false
        },
        "agentDownCount":{
            "type":"integer",
            "format":"int32"
        },
        "agentStatusNACount":{
            "type":"integer",
            "format":"int32"
        },
        "agentStatusDown":{
            "type":"boolean",
            "default":false
        },
        "agentStatusNA":{
            "type":"boolean",
            "default":false
        },
        "statusPendingCount":{
            "type":"integer",
            "format":"int32"
        },
        "showCCSWarning":{
            "type":"boolean",
            "default":false
        },
        "ccsWarningText":{
            "type":"string"
        },
        "compatibleTests":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "hasOnlyCCSNodeTypes":{
            "type":"boolean",
            "default":false
        },
        "validForScriptedActions":{
            "type":"boolean",
            "default":false
        },
        "validForPageLoad":{
            "type":"boolean",
            "default":false
        },
        "validForRestWS":{
            "type":"boolean",
            "default":false
        },
        "validForHTTP":{
            "type":"boolean",
            "default":false
        },
        "longKey":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "linkCollection":{
            "type":"array",
            "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "queryTimeRange":{
            "description":"Integer query time range used by server to run user query; see <a href='QP_Since_and_Until_Time_Range.html'>Since and Until Time Range</a> for more information",
            "$ref":"#/definitions/TimeRange"
        },
        "warnings":{
            "type":"array",
            "description":"Informational or Error messages",
            "items":{
                "$ref":"#/definitions/ErrorMessage"
            }
        }
    },
    "description":"Information about beacon pool where the synthetic test will be run"
}

Nested Schema : bpAgents

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : bpBeacons

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : compatibleTests

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : linkCollection

Type: array

See Links to Related Resources for more information

Show Source

• Array of: object Link
  Information about a Link to a resource

{
    "type":"array",
    "description":"See <a href='RD_Links_Resources.html'>Links to Related Resources</a> for more information",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : locationWarningList

Type: array

Show Source

• Array of: boolean

{
    "type":"array",
    "items":{
        "type":"boolean"
    }
}

Nested Schema : warnings

Type: array

Informational or Error messages

Show Source

• Array of: object ErrorMessage
  An error message

{
    "type":"array",
    "description":"Informational or Error messages",
    "items":{
        "$ref":"#/definitions/ErrorMessage"
    }
}

Nested Schema : Link

Type: object

Information about a Link to a resource

Show Source

• baseUrl(optional): string
  The base URL for the link
• href: string
  The href portion of the link
• post(optional): string
  The post data of the link
• rel: string
  The relationship name of the link

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship name of the link"
        },
        "href":{
            "type":"string",
            "description":"The href portion of the link"
        },
        "baseUrl":{
            "type":"string",
            "description":"The base URL for the link"
        },
        "post":{
            "type":"string",
            "description":"The post data of the link"
        }
    },
    "description":"Information about a Link to a resource"
}

Nested Schema : ErrorMessage

Type: object

An error message

Show Source

• detail: string
  A detailed description of the error
• errorType(optional): string
  Allowed Values: [ "INFO", "WARNING", "VALIDATION", "ERROR" ]

  The error type
• message: string
  The error message

{
    "type":"object",
    "required":[
        "detail",
        "message"
    ],
    "properties":{
        "errorType":{
            "type":"string",
            "description":"The error type",
            "enum":[
                "INFO",
                "WARNING",
                "VALIDATION",
                "ERROR"
            ]
        },
        "message":{
            "type":"string",
            "description":"The error message"
        },
        "detail":{
            "type":"string",
            "description":"A detailed description of the error"
        }
    },
    "description":"An error message"
}

Nested Schema : SyntheticLocation

Type: object

Information about the test locations

Show Source

• agentVersionWarningForSA(optional): boolean
  Default Value: false
• internalName(optional): string
• meid(optional): string
• name(optional): string
• noAgentWarning(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "agentVersionWarningForSA":{
            "type":"boolean",
            "default":false
        },
        "noAgentWarning":{
            "type":"boolean",
            "default":false
        },
        "meid":{
            "type":"string"
        },
        "internalName":{
            "type":"string"
        }
    },
    "description":"Information about the test locations"
}

Back to Top