curl --request POST \
--url https://dashboard.hologram.io/api/1/devices/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"counts": [
"plan_data"
],
"hitsPerPage": 0,
"orgid": 98765
}
'{
"exhaustive": true,
"filters": [
{
"field": "orgid",
"operator": "eq",
"value": 98765
}
],
"hits": [],
"hitsPerPage": 0,
"page": 1,
"query": "",
"searchTimeInMS": 6,
"sort": [],
"totalHits": 242,
"totalPages": 0,
"counts": {
"plan_data": [
{
"num_devices": 220,
"value": 0
},
{
"num_devices": 3,
"value": 5000000000
},
{
"num_devices": 2,
"value": 250000000
},
{
"num_devices": 1,
"value": 500000
},
{
"num_devices": 1,
"value": 1000000
}
]
}
}Search for devices
curl --request POST \
--url https://dashboard.hologram.io/api/1/devices/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"counts": [
"plan_data"
],
"hitsPerPage": 0,
"orgid": 98765
}
'{
"exhaustive": true,
"filters": [
{
"field": "orgid",
"operator": "eq",
"value": 98765
}
],
"hits": [],
"hitsPerPage": 0,
"page": 1,
"query": "",
"searchTimeInMS": 6,
"sort": [],
"totalHits": 242,
"totalPages": 0,
"counts": {
"plan_data": [
{
"num_devices": 220,
"value": 0
},
{
"num_devices": 3,
"value": 5000000000
},
{
"num_devices": 2,
"value": 250000000
},
{
"num_devices": 1,
"value": 500000
},
{
"num_devices": 1,
"value": 1000000
}
]
}
}Documentation Index
Fetch the complete documentation index at: https://docs.hologram.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key.
You can find your API key on the Hologram Dashboard under Account Settings.
Body
If this is set to 0, then the ES response objects will not be returned. If set to N > 0, then only the first N ES response objects will be returned. If not set, the endpoint defaults to 30 hits per page.
Which column, if any, to sort by, and in which direction
Show child attributes
Show child attributes
{ "links_cur_billing_data_used": "ASC" }Filters to use when filtering by columns on the ElasticSearch index.
Show child attributes
Show child attributes
Which columns to provide counts for (usually link_state_connected or plan_name)
Search columns:
id- device IDeid- device EUICC IDimei- device IMEIlast_connect_time- device's last connect timelinks_cur_billing_data_used- device data used during the last billing periodwhenclaimed- time when the device was claimedname- device nameorgid- ID of the organization the device is assigned tophonenumber- phone number for the deviceplan_id- plan ID assigned to device's active profileplan_name- plan name assigned to device's active profileplan_zone- plan zone assigned to device's active profileplan_data- allocated plan data assigned to device's active profiletags- tags for the deviceactive_iccid- active profile's ICCIDactive_imsi- active profile's IMSIactive_msisdn- active profile's MSISDNactive_link_id- active profile's link IDactive_link_state_connected- active profile's link stateactive_link_state- active profile's link stateactive_profile_state- active profile's EUICC statebootstrap_iccid- bootstrap profile's ICCIDbootstrap_msisdn- bootstrap profile's MSISDNbootstrap_profile_type- bootstrap profile's EUICC state
id, eid, imei, last_connect_time, links_cur_billing_data_used, whenclaimed, name, orgid, phonenumber, plan_id, plan_name, plan_zone, plan_data, tags, active_iccid, active_imsi, active_msisdn, active_link_id, active_link_state_connected, active_link_state, active_profile_type, bootstrap_iccid, bootstrap_msisdn, bootstrap_imsi, bootstrap_profile_type, link_state, link_state_connected, imsi, msisdn, iccid, link_id, link_last_connect_time, link_cur_billing_data_used Was this page helpful?