Skip to main content
POST
/
organizations
/
{organizationID}
/
projects
/
{projectID}
/
branches
/
{branchID}
/
logs
Retrieve branch logs
curl --request POST \
  --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/logs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "filters": [
    {
      "values": [
        "<string>"
      ],
      "value": "<string>"
    }
  ],
  "limit": 100,
  "cursor": "<string>"
}
'
import requests

url = "https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/logs"

payload = {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"filters": [
{
"values": ["<string>"],
"value": "<string>"
}
],
"limit": 100,
"cursor": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start: '2023-11-07T05:31:56Z',
end: '2023-11-07T05:31:56Z',
filters: [{values: ['<string>'], value: '<string>'}],
limit: 100,
cursor: '<string>'
})
};

fetch('https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/logs', 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.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/logs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z',
'filters' => [
[
'values' => [
'<string>'
],
'value' => '<string>'
]
],
'limit' => 100,
'cursor' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/logs"

payload := strings.NewReader("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"limit\": 100,\n \"cursor\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/logs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"limit\": 100,\n \"cursor\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/logs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"filters\": [\n {\n \"values\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"limit\": 100,\n \"cursor\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "logs": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "instanceID": "<string>",
      "message": "<string>",
      "process": "<string>"
    }
  ],
  "nextCursor": "<string>"
}
{
"message": "<string>",
"id": "<string>"
}
{
"message": "<string>",
"id": "<string>"
}
{
"message": "<string>",
"id": "<string>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organizationID
string
required
Pattern: [a-zA-Z0-9_-~:]+
projectID
string
required
branchID
string
required

Body

application/json
start
string<date-time>
required

Start time

end
string<date-time>
required

End time

filters
object[]

Filters applied to log entries. Multiple filters are combined with AND.

limit
integer
default:100
Required range: 1 <= x <= 200
cursor
string

Pagination cursor from a previous response

Response

Logs for a branch

A collection of logs for each of the instances of a branch

start
string<date-time>
required
end
string<date-time>
required
logs
object[]
required
nextCursor
string | null
required

Pagination cursor for the next page