Skip to main content
POST
/
core.v1.LogsService
/
GetLogsFromNaturalLanguage
cURL
curl -X POST "https://api.joinformal.com/core.v1.LogsService/GetLogsFromNaturalLanguage" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "logs": [
    {}
  ],
  "numHits": 123,
  "query": "<string>",
  "startTimestamp": "<string>",
  "endTimestamp": "<string>",
  "nextCursor": "<string>",
  "relativeTime": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
​
naturalLanguageQuery
string
Required string length: 1 - 5000
​
userTimezone
string | null
Maximum string length: 100
​
limit
integer<int32> | null

When 0, only the NL→query translation is returned (no logs are fetched).

Required range: 0 <= x <= 100

Response

Success

​
logs
logs · object[]
​
numHits
​
query
string
​
startTimestamp
string
​
endTimestamp
string
​
nextCursor
string
​
relativeTime
string

Original relative time window from the LLM translation (e.g. "7d", "1h"). Empty when the LLM used absolute timestamps or no time constraint was specified.