Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
network

/api/v1/network/item/markers

GET
/api/v1/network/item/markers
curl --request GET \
  --url 'https://dpg.example.com/api/v1/network/item/markers?item_network=example&item_domain=example&limit=200&offset=0&include_retired=true' \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
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)$/
item_network
required
string
>= 1 characters
item_domain
required
string
>= 1 characters
item_type
string
>= 1 characters
item_instance_url
string format: uri
nullable
item_schema_url
string format: uri
nullable
item_state
object
key
additional properties
item_latitude
number
item_longitude
number
radius_meters
number
min_lat
number
>= -90 <= 90
min_lng
number
>= -180 <= 180
max_lat
number
>= -90 <= 90
max_lng
number
>= -180 <= 180
limit
integer
default: 200 >= 1 <= 25000
offset
integer
0 <= 9007199254740991
cache_ttl_seconds
integer
<= 9007199254740991
include_retired
string
Allowed values: true false
q
string
>= 1 characters

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
partial
required
boolean
unavailable_instances
required
Array<string>
markers
required
Array<object>
object
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_domain
required
string
item_instance_url
required
string format: uri
nullable
item_locations
required
Array<object>
object
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
label
string
Examplegenerated
{
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1,
    "partial": true,
    "unavailable_instances": [
      "example"
    ]
  },
  "markers": [
    {
      "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "item_domain": "example",
      "item_instance_url": "https://example.com",
      "item_locations": [
        {
          "lat": 1,
          "lng": 1,
          "label": "example"
        }
      ]
    }
  ]
}