Skip to content

Search feed definitions

POST
/v3/feeds/definitions/search
curl --request POST \
--url https://us-gov.legion.picogrid.com/v3/feeds/definitions/search \
--header 'Content-Type: application/json' \
--data '{ "category": "MESSAGE", "created_after": "2024-01-01T00:00:00Z", "created_before": "2024-12-31T23:59:59Z", "data_type": "sample_value", "entity_id": "c3d4e5f6-a1b2-7890-1234-567890abcdef", "feed_name": "sensor_telemetry", "integration_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "is_active": "true", "is_template": "false", "organization_id": "550e8400-e29b-41d4-a716-446655440000", "template_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Search feed definitions with filtering and pagination

offset
number
limit
number
Media typeapplication/json
object
category
string
Allowed values: MESSAGE FILE
Example
sample_value
created_after
string
Example
2024-01-01T00:00:00Z
created_before
string
Example
2024-12-31T23:59:59Z
data_type
string
Example
sample_value
entity_id
string format: uuid
Example
c3d4e5f6-a1b2-7890-1234-567890abcdef
feed_name
string
Example
sensor_telemetry
integration_id
string format: uuid
is_active
boolean
Example
true
is_template
boolean
Example
false
organization_id
string format: uuid
Example
550e8400-e29b-41d4-a716-446655440000
template_id
string format: uuid

Successful response

Media typeapplication/json
object
paging
required
object
next
number
previous
number
results
required
Array<object>
object
category
required
string
Allowed values: MESSAGE FILE
created_at
required
string
data_type
required
string
description
string
entity_id
string format: uuid
feed_name
required
string
id
required
string format: uuid
integration_id
string format: uuid
is_active
required
boolean
is_template
required
boolean
metadata
object
organization_id
required
string format: uuid
schema_definition
object
template_id
string format: uuid
updated_at
required
string
total_count
required
number
Example
{
"paging": "sample_value",
"results": "sample_value",
"total_count": "18"
}

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