Skip to content

Search feed data

POST
/v3/feeds/search
curl --request POST \
--url 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/feeds/search?limit=10&offset=0' \
--header 'Content-Type: application/json' \
--data '{ "blob_content_types": [ "application/json", "image/jpeg" ], "blob_storage_types": [ "S3", "GCS" ], "data_types": [ "application/json", "text/plain" ], "entity_ids": [ "e5f6a1b2-c3d4-7890-1234-567890abcdef", "c3d4e5f6-a1b2-7890-1234-567890abcdef" ], "feed_definition_ids": [ "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a", "a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d" ], "received_after": "2024-01-01T00:00:00Z", "received_before": "2024-12-31T23:59:59Z", "recorded_after": "2024-01-01T00:00:00Z", "recorded_before": "2024-12-31T23:59:59Z", "sort_fields": [ {} ] }'

Search feed data with complex filtering and pagination

limit
integer
default: 10 >= 1 <= 100
Example
10
offset
integer
0
Example
0
Media typeapplication/json
object
blob_content_types
Array<string>
Example
[
"application/json",
"image/jpeg"
]
blob_storage_types
Array<string>
Example
[
"S3",
"GCS"
]
data_types
Array<string>
Example
[
"application/json",
"text/plain"
]
entity_ids
Array<string>
Example
[
"e5f6a1b2-c3d4-7890-1234-567890abcdef",
"c3d4e5f6-a1b2-7890-1234-567890abcdef"
]
feed_definition_ids
Array<string>
Example
[
"d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
"a8b9c0d1-e2f3-4a5b-6c7d-8e9f0a1b2c3d"
]
received_after
string
Example
2024-01-01T00:00:00Z
received_before
string
Example
2024-12-31T23:59:59Z
recorded_after
string
Example
2024-01-01T00:00:00Z
recorded_before
string
Example
2024-12-31T23:59:59Z
sort_fields
Array<object>
object
ascending
required
boolean
Example
false
field
required
string
Example
recorded_at
Example
[
{}
]

Successful response

Media typeapplication/json
object
paging
required
object
next
required
integer | null
previous
required
integer | null
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
id
required
string format: uuid
organization_id
required
string format: uuid
payload
object
received_at
required
string
recorded_at
required
string
total_count
required
integer
Example
{
"paging": {
"next": 2,
"previous": null
},
"results": [
{
"blob_content_type": null,
"blob_key": null,
"blob_metadata": null,
"blob_size_bytes": null,
"blob_storage_type": null,
"entity_id": "e5f6a1b2-c3d4-7890-1234-567890abcdef",
"feed_definition_id": "d5e6f7a8-b9c0-1d2e-3f4a-5b6c7d8e9f0a",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
"code": 400,
"details": [
{
"Field": "organization_id",
"Issue": "must be a valid UUID format"
}
],
"message": "Request cannot be processed due to invalid input",
"status": "error",
"timestamp": "2026-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Unauthorized

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
"code": 401,
"details": [
{
"Field": "authorization_header",
"Issue": "Bearer token is expired or malformed"
}
],
"message": "Authentication credentials are missing or invalid",
"status": "error",
"timestamp": "2026-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Forbidden

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
"code": 403,
"details": [
{
"Field": "required_scope",
"Issue": "requires 'orion:settings:write' scope, but token only has 'orion:settings:read'"
}
],
"message": "Access denied: insufficient permissions for this resource",
"status": "error",
"timestamp": "2026-01-15T14:32:45Z",
"trace_id": "req_2J9K8L7M6N5P4Q3R"
}

Not Found

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
"code": 404,
"details": [
{
"Field": "organization_id",
"Issue": "organization with ID 'a1b2c3d4-e5f6-7890-abcd-ef1234567890' not found"
}
],
"message": "The requested resource could not be found",
"status": "error",
"timestamp": "2026-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

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.14.0 · commit 0771262