Retrieve contextual information for a given sequence and log

curl --request GET \
  --url https://api.eu.bronto.io/context \
  --header 'X-BRONTO-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-BRONTO-API-KEY': '<api-key>'}};

fetch('https://api.eu.bronto.io/context', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eu.bronto.io/context",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BRONTO-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eu.bronto.io/context"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BRONTO-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.eu.bronto.io/context")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BRONTO-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "explain": {
    "Execution time (millis)": "353"
  },
  "result": [
    {
      "@time": "2024-03-27 10:25:40.632 UTC",
      "@sequence": "111721913",
      "@raw": "10.0.0.1 - - [27/Mar/2024:10:54:39 +0000] \"GET / HTTP/1.1\" 200 721 \"-\" \"ELB-HealthChecker/2.0\"",
      "@context": "https://api.bronto.io/context?sequence=111721913&limit=1&from=23746675-7022-4985-bd74-4af9eba58d72&timestamp=1711535140632&direction=both",
      "metadata": {
        "logId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "timestamp": 1711535140632,
        "sequence": 111721913,
        "origin": "10.0.0.1",
        "context": "https://api.bronto.io/context?sequence=111721913&limit=1&from=23746675-7022-4985-bd74-4af9eba58d72&timestamp=1711535140632&direction=both",
        "selectedKeys": {
          "@time": "2024-03-27 10:25:40.632 UTC"
        },
        "unselectedKeys": {
          "id": "message_0",
          "current_time": 1711535140
        }
      },
      "links": [
        {
          "rel": "context",
          "href": "https://api.bronto.io/context?sequence=111721913&limit=1&from=23746675-7022-4985-bd74-4af9eba58d72&timestamp=1711535140632&direction=both"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "next",
      "href": "<string>"
    }
  ]
}

{
  "code": 400,
  "type": "Bad Request",
  "correlation_id": "95c6a974e3ab01209b6b0dfedb1b16c5",
  "details": "Validation failed: 'name' field is required and cannot be empty"
}

{
  "code": 404,
  "type": "Not Found",
  "correlation_id": "605f832bcfe44a1081441691c8d42253",
  "details": "Resource not found."
}

{
  "code": 429,
  "type": "Too Many Requests",
  "correlation_id": "53909ed43c544531b7a555e295960437",
  "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window."
}

{
  "code": 500,
  "type": "Internal Server Error",
  "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
  "details": "Internal Server Error"
}

{
  "code": 500,
  "type": "Internal Server Error",
  "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
  "details": "Internal Server Error"
}

GET

context

Retrieve contextual information for a given sequence and log

curl --request GET \
  --url https://api.eu.bronto.io/context \
  --header 'X-BRONTO-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-BRONTO-API-KEY': '<api-key>'}};

fetch('https://api.eu.bronto.io/context', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eu.bronto.io/context",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-BRONTO-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eu.bronto.io/context"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-BRONTO-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.eu.bronto.io/context")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-BRONTO-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "explain": {
    "Execution time (millis)": "353"
  },
  "result": [
    {
      "@time": "2024-03-27 10:25:40.632 UTC",
      "@sequence": "111721913",
      "@raw": "10.0.0.1 - - [27/Mar/2024:10:54:39 +0000] \"GET / HTTP/1.1\" 200 721 \"-\" \"ELB-HealthChecker/2.0\"",
      "@context": "https://api.bronto.io/context?sequence=111721913&limit=1&from=23746675-7022-4985-bd74-4af9eba58d72&timestamp=1711535140632&direction=both",
      "metadata": {
        "logId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "timestamp": 1711535140632,
        "sequence": 111721913,
        "origin": "10.0.0.1",
        "context": "https://api.bronto.io/context?sequence=111721913&limit=1&from=23746675-7022-4985-bd74-4af9eba58d72&timestamp=1711535140632&direction=both",
        "selectedKeys": {
          "@time": "2024-03-27 10:25:40.632 UTC"
        },
        "unselectedKeys": {
          "id": "message_0",
          "current_time": 1711535140
        }
      },
      "links": [
        {
          "rel": "context",
          "href": "https://api.bronto.io/context?sequence=111721913&limit=1&from=23746675-7022-4985-bd74-4af9eba58d72&timestamp=1711535140632&direction=both"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "next",
      "href": "<string>"
    }
  ]
}

{
  "code": 400,
  "type": "Bad Request",
  "correlation_id": "95c6a974e3ab01209b6b0dfedb1b16c5",
  "details": "Validation failed: 'name' field is required and cannot be empty"
}

{
  "code": 404,
  "type": "Not Found",
  "correlation_id": "605f832bcfe44a1081441691c8d42253",
  "details": "Resource not found."
}

{
  "code": 429,
  "type": "Too Many Requests",
  "correlation_id": "53909ed43c544531b7a555e295960437",
  "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window."
}

{
  "code": 500,
  "type": "Internal Server Error",
  "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
  "details": "Internal Server Error"
}

{
  "code": 500,
  "type": "Internal Server Error",
  "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
  "details": "Internal Server Error"
}

Authorizations

X-BRONTO-API-KEY

string

header

required

Query Parameters

from

string

The ids of the logs to search. One of either the from or the from_expr parameters must be specified.

from_expr

string

Expression used to select a set of logs. The expression defines the criteria for which logs are included and is applied across all available logs to produce the input set. Supports logical operators (AND, OR), comparison operators (=, !=), and quoted string literals.

timestamp

integer

required

The timestamp for the event for which context is being retrieved

limit

integer

default:100

The maximum number of events that an event search should return. In a query with a group by, it limits the number of groups returned. It does not affect a statistical search using aggregate functions.

Required range: 1 <= x <= 10000

from_sequence

integer

The starting sequence for which to query data. This is more granular than a timestamp but also requires a from_ts param.

direction

enum<string>

Enum to indicate if results before or after should be retrieved.

Available options:

both,

after,

before

explain_only

boolean

If set to true then only the explain element of the response will be populated. The explain element will contain the Approximate bytes in time range attribute which provides an estimate for the amount of data present in the time range for the selected datasets. This parameter is set to false by default.

Response

Search results

explain

object

details on the query execution

Show child attributes

result

object[]

Show child attributes

links

object[]

Option 1
Option 2

Show child attributes

API overview

api-keys

users

groups

search

context

live-tail

logs

datasets

monitors

dashboards

collections

access

downtimes

events

forward

roles

top-keys

widgets

integrations

exports

customers

tags

limits

permissions

ai

policies

encryption-keys

metrics

timeseries

patterns

Retrieve contextual information for a given sequence and log

Authorizations

Query Parameters

Response