- Legion API
- Events
- Search events
Search events
POST
/v3/events/search
const url = 'https://us-gov.legion.picogrid.com/v3/events/search';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"filters":{"actor_ids":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"actor_types":["example"],"after_event_timestamp":"example","before_event_timestamp":"example","created_after":"example","created_before":"example","event_description":"example","event_types":["example"],"source_ids":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]},"sort":[{"field":"example","order":"asc"}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://us-gov.legion.picogrid.com/v3/events/search \ --header 'Content-Type: application/json' \ --data '{ "filters": { "actor_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "actor_types": [ "example" ], "after_event_timestamp": "example", "before_event_timestamp": "example", "created_after": "example", "created_before": "example", "event_description": "example", "event_types": [ "example" ], "source_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }, "sort": [ { "field": "example", "order": "asc" } ] }'Search events with complex filtering and pagination
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”limit
number
offset
number
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
filters
object
actor_ids
Array<string>
actor_types
Array<string>
after_event_timestamp
string
before_event_timestamp
string
created_after
string
created_before
string
event_description
string
event_types
Array<string>
source_ids
Array<string>
sort
Array<object>
object
field
required
string
order
required
string
Responses
Section titled “Responses”Successful response
Media typeapplication/json
object
paging
required
object
next
number
previous
number
results
required
Array<object>
object
actor_id
string format: uuid
actor_type
string
created_at
required
string
event_description
string
event_timestamp
required
string
event_type
required
string
id
required
string format: uuid
metadata
object
organization_id
required
string format: uuid
source_id
required
string format: uuid
total_count
required
number
Example
2023-12-15T14:30:00ZBad Request
Media typeapplication/json
object
category
string
code
number
details
Array<object>
object
field
required
string
issue
required
string
message
string
status
string
timestamp
string
trace_id
string
Example
{ "code": "400", "details": "sample_value", "message": "Request cannot be processed due to invalid input", "status": "error", "timestamp": "2025-01-15T14:32:45Z", "trace_id": "req_2J9K8L7M6N5P4Q3R"}Unauthorized
Media typeapplication/json
object
category
string
code
number
details
Array<object>
object
field
required
string
issue
required
string
message
string
status
string
timestamp
string
trace_id
string
Example
{ "code": "401", "details": "sample_value", "message": "Authentication credentials are missing or invalid", "status": "error", "timestamp": "2025-01-15T14:32:45Z", "trace_id": "req_2J9K8L7M6N5P4Q3R"}Forbidden
Media typeapplication/json
object
category
string
code
number
details
Array<object>
object
field
required
string
issue
required
string
message
string
status
string
timestamp
string
trace_id
string
Example
{ "code": "403", "details": "sample_value", "message": "Access denied: insufficient permissions for this resource", "status": "error", "timestamp": "2025-01-15T14:32:45Z", "trace_id": "req_2J9K8L7M6N5P4Q3R"}Not Found
Media typeapplication/json
object
category
string
code
number
details
Array<object>
object
field
required
string
issue
required
string
message
string
status
string
timestamp
string
trace_id
string
Example
{ "code": "404", "details": "sample_value", "message": "The requested resource could not be found", "status": "error", "timestamp": "2025-01-15T14:32:45Z", "trace_id": "req_2J9K8L7M6N5P4Q3R"}Internal Server Error
Media typeapplication/json
object
category
required
The category of the error
string
code
required
The HTTP status code
number
details
required
Additional details about the error
Array<object>
object
field
The field that caused the error
string
issue
The specific issue with the field
string
message
required
A human-readable error message
string
status
required
The status of the response, always ‘error’ for error responses
string
timestamp
required
The timestamp when the error occurred
string format: date-time
trace_id
required
A unique identifier for tracing the error
string format: uuid
Example
{ "category": "server_error", "code": "500", "details": [ { "field": "field_name", "issue": "Field validation issue" } ], "message": "Internal Server Error", "status": "error", "timestamp": "2024-03-15T10:30:00Z", "trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"}Version 3.0.0 · commit 0771262
