Skip to content

Search feed data

POST
/v3/feeds/search
curl --request POST \
--url https://us-gov.legion.picogrid.com/v3/feeds/search \
--header 'Content-Type: application/json' \
--data '{ "blob_content_types": "sample_value", "blob_storage_types": "sample_value", "created_after": "2024-01-01T00:00:00Z", "created_before": "2024-12-31T23:59:59Z", "data_types": "sample_value", "entity_ids": "sample_value", "feed_definition_ids": "sample_value", "recorded_after": "2024-01-01T00:00:00Z", "recorded_before": "2024-12-31T23:59:59Z", "sort_fields": "sample_value" }'

Search feed data with complex filtering and pagination

limit
number
offset
number
Media typeapplication/json
object
blob_content_types
Array<string>
Example
sample_value
blob_storage_types
Array<string>
Example
sample_value
created_after
string
Example
2024-01-01T00:00:00Z
created_before
string
Example
2024-12-31T23:59:59Z
data_types
Array<string>
Example
sample_value
entity_ids
Array<string>
Example
sample_value
feed_definition_ids
Array<string>
Example
sample_value
recorded_after
string
Example
2024-01-01T00:00:00Z
recorded_before
string
Example
2024-12-31T23:59:59Z
sort_fields
Array<object>
object
ascending
boolean
Example
false
field
string
Example
recorded_at
Example
sample_value

Successful response

Media typeapplication/json
object
paging
required
object
next
number
previous
number
results
required
Array<object>
object
blob_content_type
string
blob_key
string
blob_metadata
object
blob_size_bytes
number
blob_storage_type
string
entity_id
required
string format: uuid
feed_definition_id
required
string format: uuid
organization_id
required
string format: uuid
payload
object
received_at
required
string
recorded_at
required
string
total_count
required
number
Example
{
"paging": "sample_value",
"results": [
{
"blob_content_type": "",
"blob_key": "",
"blob_metadata": "",
"blob_size_bytes": "",
"blob_storage_type": "",
"entity_id": "e5f6a1b2-c3d4-7890-1234-567890abcdef",
"feed_definition_id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
"organization_id": "550e8400-e29b-41d4-a716-446655440000",
"payload": {
"humidity": 65.2,
"pressure": 1013.25,
"temperature": 25.5,
"timestamp": "2024-01-15T11:00:00Z"
},
"received_at": "2024-03-11T16:00:00Z",
"recorded_at": "2024-01-15T11:00:00Z"
}
],
"total_count": "158"
}

Bad 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