Skip to main content
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>'
import requests

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

headers = {"X-BRONTO-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
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))

}
HttpResponse<String> response = Unirest.get("https://api.eu.bronto.io/context")
  .header("X-BRONTO-API-KEY", "<api-key>")
  .asString();
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>"
    }
  ]
}
{
  "bad_request_validation": {
    "summary": "Bad Request - Validation Error",
    "description": "Example error when request validation fails",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "95c6a974e3ab01209b6b0dfedb1b16c5",
      "details": "Validation failed: 'name' field is required and cannot be empty"
    }
  },
  "bad_request_invalid_type": {
    "summary": "Bad Request - Invalid Metric Type",
    "description": "Example error when an invalid metric type is provided",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "00d8a51bb2874f2583670317a4fb8db7",
      "details": "Invalid metric_type 'INVALID'. Must be one of: COUNTER, GAUGE, HISTOGRAM"
    }
  },
  "forbidden": {
    "summary": "Forbidden Access",
    "description": "Example error when user lacks required permissions",
    "value": {
      "code": 403,
      "type": "Forbidden",
      "correlation_id": "40276639de0f49d586e32edd8c4f6b34",
      "details": "Access denied. User does not have permission to create metric definition templates"
    }
  },
  "not_found": {
    "summary": "Resource Not Found",
    "description": "Example error when requested resource doesn't exist",
    "value": {
      "code": 404,
      "type": "Not Found",
      "correlation_id": "605f832bcfe44a1081441691c8d42253",
      "details": "Metric definition template with id '550e8400-e29b-41d4-a716-446655440000' not found"
    }
  },
  "rate_limit": {
    "summary": "Rate Limit Exceeded",
    "description": "Example error when API rate limit is exceeded",
    "value": {
      "code": 429,
      "type": "Too Many Requests",
      "correlation_id": "53909ed43c544531b7a555e295960437",
      "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window"
    }
  },
  "internal_server_error": {
    "summary": "Internal Server Error",
    "description": "Example error for unexpected server-side failures",
    "value": {
      "code": 500,
      "type": "Internal Server Error",
      "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
      "details": "An unexpected error occurred while processing your request"
    }
  }
}
{
  "bad_request_validation": {
    "summary": "Bad Request - Validation Error",
    "description": "Example error when request validation fails",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "95c6a974e3ab01209b6b0dfedb1b16c5",
      "details": "Validation failed: 'name' field is required and cannot be empty"
    }
  },
  "bad_request_invalid_type": {
    "summary": "Bad Request - Invalid Metric Type",
    "description": "Example error when an invalid metric type is provided",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "00d8a51bb2874f2583670317a4fb8db7",
      "details": "Invalid metric_type 'INVALID'. Must be one of: COUNTER, GAUGE, HISTOGRAM"
    }
  },
  "forbidden": {
    "summary": "Forbidden Access",
    "description": "Example error when user lacks required permissions",
    "value": {
      "code": 403,
      "type": "Forbidden",
      "correlation_id": "40276639de0f49d586e32edd8c4f6b34",
      "details": "Access denied. User does not have permission to create metric definition templates"
    }
  },
  "not_found": {
    "summary": "Resource Not Found",
    "description": "Example error when requested resource doesn't exist",
    "value": {
      "code": 404,
      "type": "Not Found",
      "correlation_id": "605f832bcfe44a1081441691c8d42253",
      "details": "Metric definition template with id '550e8400-e29b-41d4-a716-446655440000' not found"
    }
  },
  "rate_limit": {
    "summary": "Rate Limit Exceeded",
    "description": "Example error when API rate limit is exceeded",
    "value": {
      "code": 429,
      "type": "Too Many Requests",
      "correlation_id": "53909ed43c544531b7a555e295960437",
      "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window"
    }
  },
  "internal_server_error": {
    "summary": "Internal Server Error",
    "description": "Example error for unexpected server-side failures",
    "value": {
      "code": 500,
      "type": "Internal Server Error",
      "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
      "details": "An unexpected error occurred while processing your request"
    }
  }
}
{
  "bad_request_validation": {
    "summary": "Bad Request - Validation Error",
    "description": "Example error when request validation fails",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "95c6a974e3ab01209b6b0dfedb1b16c5",
      "details": "Validation failed: 'name' field is required and cannot be empty"
    }
  },
  "bad_request_invalid_type": {
    "summary": "Bad Request - Invalid Metric Type",
    "description": "Example error when an invalid metric type is provided",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "00d8a51bb2874f2583670317a4fb8db7",
      "details": "Invalid metric_type 'INVALID'. Must be one of: COUNTER, GAUGE, HISTOGRAM"
    }
  },
  "forbidden": {
    "summary": "Forbidden Access",
    "description": "Example error when user lacks required permissions",
    "value": {
      "code": 403,
      "type": "Forbidden",
      "correlation_id": "40276639de0f49d586e32edd8c4f6b34",
      "details": "Access denied. User does not have permission to create metric definition templates"
    }
  },
  "not_found": {
    "summary": "Resource Not Found",
    "description": "Example error when requested resource doesn't exist",
    "value": {
      "code": 404,
      "type": "Not Found",
      "correlation_id": "605f832bcfe44a1081441691c8d42253",
      "details": "Metric definition template with id '550e8400-e29b-41d4-a716-446655440000' not found"
    }
  },
  "rate_limit": {
    "summary": "Rate Limit Exceeded",
    "description": "Example error when API rate limit is exceeded",
    "value": {
      "code": 429,
      "type": "Too Many Requests",
      "correlation_id": "53909ed43c544531b7a555e295960437",
      "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window"
    }
  },
  "internal_server_error": {
    "summary": "Internal Server Error",
    "description": "Example error for unexpected server-side failures",
    "value": {
      "code": 500,
      "type": "Internal Server Error",
      "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
      "details": "An unexpected error occurred while processing your request"
    }
  }
}
{
  "bad_request_validation": {
    "summary": "Bad Request - Validation Error",
    "description": "Example error when request validation fails",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "95c6a974e3ab01209b6b0dfedb1b16c5",
      "details": "Validation failed: 'name' field is required and cannot be empty"
    }
  },
  "bad_request_invalid_type": {
    "summary": "Bad Request - Invalid Metric Type",
    "description": "Example error when an invalid metric type is provided",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "00d8a51bb2874f2583670317a4fb8db7",
      "details": "Invalid metric_type 'INVALID'. Must be one of: COUNTER, GAUGE, HISTOGRAM"
    }
  },
  "forbidden": {
    "summary": "Forbidden Access",
    "description": "Example error when user lacks required permissions",
    "value": {
      "code": 403,
      "type": "Forbidden",
      "correlation_id": "40276639de0f49d586e32edd8c4f6b34",
      "details": "Access denied. User does not have permission to create metric definition templates"
    }
  },
  "not_found": {
    "summary": "Resource Not Found",
    "description": "Example error when requested resource doesn't exist",
    "value": {
      "code": 404,
      "type": "Not Found",
      "correlation_id": "605f832bcfe44a1081441691c8d42253",
      "details": "Metric definition template with id '550e8400-e29b-41d4-a716-446655440000' not found"
    }
  },
  "rate_limit": {
    "summary": "Rate Limit Exceeded",
    "description": "Example error when API rate limit is exceeded",
    "value": {
      "code": 429,
      "type": "Too Many Requests",
      "correlation_id": "53909ed43c544531b7a555e295960437",
      "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window"
    }
  },
  "internal_server_error": {
    "summary": "Internal Server Error",
    "description": "Example error for unexpected server-side failures",
    "value": {
      "code": 500,
      "type": "Internal Server Error",
      "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
      "details": "An unexpected error occurred while processing your request"
    }
  }
}
{
  "bad_request_validation": {
    "summary": "Bad Request - Validation Error",
    "description": "Example error when request validation fails",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "95c6a974e3ab01209b6b0dfedb1b16c5",
      "details": "Validation failed: 'name' field is required and cannot be empty"
    }
  },
  "bad_request_invalid_type": {
    "summary": "Bad Request - Invalid Metric Type",
    "description": "Example error when an invalid metric type is provided",
    "value": {
      "code": 400,
      "type": "Bad Request",
      "correlation_id": "00d8a51bb2874f2583670317a4fb8db7",
      "details": "Invalid metric_type 'INVALID'. Must be one of: COUNTER, GAUGE, HISTOGRAM"
    }
  },
  "forbidden": {
    "summary": "Forbidden Access",
    "description": "Example error when user lacks required permissions",
    "value": {
      "code": 403,
      "type": "Forbidden",
      "correlation_id": "40276639de0f49d586e32edd8c4f6b34",
      "details": "Access denied. User does not have permission to create metric definition templates"
    }
  },
  "not_found": {
    "summary": "Resource Not Found",
    "description": "Example error when requested resource doesn't exist",
    "value": {
      "code": 404,
      "type": "Not Found",
      "correlation_id": "605f832bcfe44a1081441691c8d42253",
      "details": "Metric definition template with id '550e8400-e29b-41d4-a716-446655440000' not found"
    }
  },
  "rate_limit": {
    "summary": "Rate Limit Exceeded",
    "description": "Example error when API rate limit is exceeded",
    "value": {
      "code": 429,
      "type": "Too Many Requests",
      "correlation_id": "53909ed43c544531b7a555e295960437",
      "details": "Rate limit exceeded. Maximum 100 requests are allowed within a 5-minute window"
    }
  },
  "internal_server_error": {
    "summary": "Internal Server Error",
    "description": "Example error for unexpected server-side failures",
    "value": {
      "code": 500,
      "type": "Internal Server Error",
      "correlation_id": "b129b8e0e66c41aa9541a30f67e38ce2",
      "details": "An unexpected error occurred while processing your request"
    }
  }
}

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

​
result
object[]
​
links
object[]