sensors.Africa API
get-auth-token
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
username required | Valid username for authentication |
password required | Valid password for authentication |
v1
data > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
sensor | |
timestamp | |
timestamp__gte | |
timestamp__lte |
data > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this sensor data. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
sensor | |
timestamp | |
timestamp__gte | |
timestamp__lte |
node > list
Show all nodes belonging to authenticated user
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
location__country | |
location__city | |
last_notify | |
last_notify__gte | |
last_notify__lte |
node > read
Show all nodes belonging to authenticated user
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this node. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
location__country | |
location__city | |
last_notify | |
last_notify__gte | |
last_notify__lte |
push-sensor-data > create
This endpoint is to POST data from the sensor to the api.
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
sensor | |
sampling_rate | in milliseconds |
timestamp | |
sensordatavalues required | |
software_version | sensor software version |
sensor > list
This endpoint is to download sensor data from the api.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
sensor > read
This endpoint is to download sensor data from the api.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this sensor. |
sensors > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
sensor_id required |
user > list
Get more information about users
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
ordering | Which field to use when ordering the results. |
user > read
Get more information about users
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this user. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
ordering | Which field to use when ordering the results. |
v2
cities > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
data > list
This endpoint is to download sensor data from the api.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
next_page | The pagination cursor value. |
sensor | |
sensor__public | |
location__country | |
location__city | |
timestamp__gte | |
timestamp__lte |
data > read
This endpoint is to download sensor data from the api.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this sensor data. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
sensor | |
sensor__public | |
location__country | |
location__city | |
timestamp__gte | |
timestamp__lte |
data > list_0
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
sensor_type required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
locations > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
sensor-types > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
sensors > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |