Liveux Backend REST API Documentation

External API -- V1

All requests require authentication by OAuth Bearer Token.

GET /status

Gets operational status information about the application.

• Request parameter renderType, optional, describes how the result should be rendered, and must be one of the following: "compact", "pretty". Only affects the JSON content type. If unspecified, defaults to "compact". Pretty is easier to read, while compact uses less bandwidth and has a slight performance advantage.
• Examples:
  • /status

GET /versionInfo

Gets information about the application version.

• Request parameter renderType, optional, describes how the result should be rendered, and must be one of the following: "compact", "pretty". Only affects the JSON content type. If unspecified, defaults to "compact". Pretty is easier to read, while compact uses less bandwidth and has a slight performance advantage.
• Examples:
  • /versionInfo

GET /databaseInfo

Gets information about the database.

• Request parameter renderType, optional, describes how the result should be rendered, and must be one of the following: "compact", "pretty". Only affects the JSON content type. If unspecified, defaults to "compact". Pretty is easier to read, while compact uses less bandwidth and has a slight performance advantage.
• Examples:
  • /databaseInfo

GET /measurements or POST /measurements

Queries for measurements for a given tenant. Various request parameters allow the data to be aggregated.

• Request parameter tenantId, required, specifies the owner of the dataset to access.
• Request parameter renderType, optional, describes how the result should be rendered, and must be one of the following: "compact", "pretty". Only affects the JSON content type. If unspecified, defaults to "compact". Pretty is easier to read, while compact uses less bandwidth and has a slight performance advantage.
• Request parameter view, optional, describes the view to present, and must be one of the following: "aggregation", "freqDist". If unspecified, defaults to "aggregation".
• Request parameter start, optional, represents query start time in milliseconds, and must be a long value or a string in ISO-8601 date/time format. If not specified, the query start time is unbounded.
• Request parameter end, optional, represents query end time in milliseconds, and must be a long value or a string in ISO-8601 date/time format. If not specified, the query end time is unbounded.
• Request parameter groupBy, optional, describes the key(s) to group by, and must be a comma-separated list of one or more of the following: "measurement", "agent", "test", "time".
• Request parameter includeStatuses, optional, of type Boolean, specifies whether alert level statuses should be included in the returned results.
• Request parameter aggregationTypes, optional, specifies which types of aggregations should be included in the returned results, and must be a comma-separated list of one or more of the following: "min", "max", "avg". If unspecified, defaults to "max".
• Request parameter summarizeBy (only available if view=aggregation), optional, describes the key(s) to summarize by, and must be a comma-separated list of one or more of the following: "measurement", "agent", "test", "time".
• Request parameter agents, optional, of type String. If provided, the parameter value is interpreted as a comma-separated list of agent ids to filter by (only records matching one of the provided agent ids will be included in the returned results).
• Request parameter tests, optional, of type String. If provided, the parameter value is interpreted as a comma-separated list of test ids to filter by (only records matching one of the provided test ids will be included in the returned results).
• Request parameter limit (only available if view=aggregation), optional, defaults to "none", defines the limit on the number of records which should be returned, and must be one of the following: "none", "first{n}", "last{n}", where n is a positive integer.
• Request parameter percentBinSize (only available if view=freqDist), optional, of type Double. Defines the bin size for percent values in the frequency distribution view. If unspecified, defaults to 1.0.
• Request parameter networkLatencyBinSize (only available if view=freqDist), optional, of type Long. Defines the bin size for network latency values in the frequency distribution view. If unspecified, defaults to 100.
• Request parameter dnsLatencyBinSize (only available if view=freqDist), optional, of type Long. Defines the bin size for dns latency values in the frequency distribution view. If unspecified, defaults to 100.
• Request parameter responseTimeBinSize (only available if view=freqDist), optional, of type Long. Defines the bin size for response time values in the frequency distribution view. If unspecified, defaults to 100.
• Examples:
  • /measurements
  • /measurements?includeStatuses=true&aggregationTypes=min,max,avg
  • /measurements?agents=a1
  • /measurements?tests=t1
  • /measurements?groupBy=measurement
  • measurements?groupBy=agent
  • /measurements?groupBy=test
  • /measurements?groupBy=agent,test
  • /measurements?groupBy=agent&summarizeBy=measurement,test
  • /measurements?groupBy=test&summarizeBy=measurement,agent
  • /measurements?agents=a1&groupBy=test
  • /measurements?start=2&end=5
  • /measurements?start=2&end=5&groupBy=agent
  • /measurements?start=2&end=5&groupBy=test
  • /measurements?view=freqDist&groupBy=agent
  • /measurements?view=freqDist&groupBy=test

GET /rawMeasurements or POST /rawMeasurements

Queries for raw measurements for a given tenant.

• Request parameter tenantId, required, specifies the owner of the dataset to access.
• Request parameter renderType, optional, describes how the result should be rendered, and must be one of the following: "compact", "pretty". Only affects the JSON content type. If unspecified, defaults to "compact". Pretty is easier to read, while compact uses less bandwidth and has a slight performance advantage.
• Request parameter start, optional, represents query start time in milliseconds, and must be a long value or a string in ISO-8601 date/time format. If not specified, the query start time is unbounded.
• Request parameter end, optional, represents query end time in milliseconds, and must be a long value or a string in ISO-8601 date/time format. If not specified, the query end time is unbounded.
• Request parameter measurements, optional, of type String. If provided, the parameter value is interpreted as a comma-separated list of measurement ids to filter by (only records matching one of the provided measurement ids will be included in the returned results).
• Request parameter agents, optional, of type String. If provided, the parameter value is interpreted as a comma-separated list of agent ids to filter by (only records matching one of the provided agent ids will be included in the returned results).
• Request parameter tests, optional, of type String. If provided, the parameter value is interpreted as a comma-separated list of test ids to filter by (only records matching one of the provided test ids will be included in the returned results).
• Request parameter taskTypes, optional, describes the task type(s) to filter by, and must be a comma-separated list of one or more task types (examples of task types: "ping", "http", "traceroute").
• Request parameter limit, optional, defaults to "none", defines the limit on the number of records which should be returned, and must be one of the following: "none", "first{n}", "last{n}", where n is a positive integer.
• Examples:
  • /rawMeasurements
  • /rawMeasurements?measurements=m1
  • /rawMeasurements?agents=a1
  • /rawMeasurements?tests=t1
  • /rawMeasurements?start=2&end=5