Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
network

/api/v1/network/item/discover

POST
/api/v1/network/item/discover
curl --request POST \
  --url https://dpg.example.com/api/v1/network/item/discover \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "item_network": "example", "item_domain": "example", "item_type": "example", "q": "example", "filters": [ { "field": "example", "values": [ "example" ] } ], "sort": "relevance", "item_latitude": 1, "item_longitude": 1, "min_lat": 1, "min_lng": 1, "max_lat": 1, "max_lng": 1, "distance_meters": 1, "ordering_latitude": 1, "ordering_longitude": 1, "anchor_item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "limit": 20, "offset": 0 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
item_network
required
string
>= 1 characters
item_domain
required
string
>= 1 characters
item_type
required
string
>= 1 characters
q
string
>= 1 characters
filters
Array<object>
object
field
required
string
>= 1 characters
values
required
Array
>= 1 items
sort
string
Allowed values: relevance newest nearest
item_latitude
number
>= -90 <= 90
item_longitude
number
>= -180 <= 180
min_lat
number
>= -90 <= 90
min_lng
number
>= -180 <= 180
max_lat
number
>= -90 <= 90
max_lng
number
>= -180 <= 180
distance_meters
number
ordering_latitude
number
>= -90 <= 90
ordering_longitude
number
>= -180 <= 180
anchor_item_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
limit
integer
default: 20 >= 1 <= 100
offset
integer
0 <= 9007199254740991

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
meta
required
object
total
required
number
limit
required
number
offset
required
number
source
required
string
Allowed values: signals_search native_fallback
degraded
required
boolean
distance_meters
number
sort_applied
string
Allowed values: relevance newest nearest
anchor_applied
required
boolean
items
required
Array<object>
object
item_network
required
string
item_domain
required
string
item_type
required
string
item_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
item_instance_url
required
string
nullable
item_schema_url
required
string
nullable
item_state
required
Any of:
Any of:
string
item_locations
required
Array<object>
object
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
label
string
created_by
required
string
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time
lifecycle_status
string
score
number
distanceMeters
number
Example
{
  "meta": {
    "source": "signals_search",
    "sort_applied": "relevance"
  },
  "items": [
    {
      "item_state": null
    }
  ]
}