Get geographical data for a page
get
/serviceapi/apm.dataserver/api/v1/sessions/getGeoMapDataSeries
Retrieve the geographical data for a known page ID
Request
Path Parameters
-
id: string
ID of page (see Get pages, Get browser callers for a request ID or similar). For more information see Object ID Parameters.
Query Parameters
-
appName(optional): string
Specifies the name of the application to query.
-
filters(optional): string
Specifies the attribute(s), operator and value, to filter on. For more information see the "filters" parameter.
-
groupBy(optional): string
Name of the attribute by which the result set is grouped:
continentCode, countryCode, regionCode, browserType, browserVersion
[default = null] -
limit(optional): integer(int32)
Maximum number of elements in the result set, useful for paging [default = all, max = 1000]. For more information see Paging.
-
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'
-
webAppName(optional): string
Specifies the name of the web application to query.
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.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object PageGeoData
Geographical information about a Page or Ajax Call (PageGeoData)
Nested Schema : PageGeoData
Type:
object
Geographical information about a Page or Ajax Call (PageGeoData)
Show Source
-
columnNames:
array columnNames
Metrics columns are: averageResponseTime, maxResponseTime, completedCount, failureCount, errorPercentage. Group-by columns are: continentCode, countryCode, regionCode, osFamily, osFamilyI18n (included if osFamily existed), osName, browserType, browserType18n (included if browserType existed), browserVersion (null by default)
-
linkCollection(optional):
array linkCollection
See Links to Related Resources for more information
-
queryTimeRange(optional):
object TimeRange
-
rows(optional):
array rows
-
warnings(optional):
array warnings
Informational or Error messages
Nested Schema : columnNames
Type:
array
Metrics columns are: averageResponseTime, maxResponseTime, completedCount, failureCount, errorPercentage. Group-by columns are: continentCode, countryCode, regionCode, osFamily, osFamilyI18n (included if osFamily existed), osName, browserType, browserType18n (included if browserType existed), browserVersion (null by default)
Show Source
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
Nested Schema : TimeRange
Type:
Show Source
object
-
sinceTime(optional):
integer(int64)
Results are returned *since* this timestamp
-
timeInMinutes(optional):
integer(int64)
-
untilTime(optional):
integer(int64)
Results are returned *until* this timestamp
Nested Schema : warnings
Type:
array
Informational or Error messages
Show Source
-
Array of:
object ErrorMessage
An error message
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
Nested Schema : items
Type:
object
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