Health
Family Planning
About This Dataset
Data & Resources
1 filesTable Preview
Loading preview...
Data API
Resource:
-
GET Request
Loading...
Supported Parameters
| Parameter | Description | Default | Type |
|---|---|---|---|
id |
Unique identifier of the file | - |
string required |
filters |
Matching conditions to select, e.g. {"field1": "a", "field2": "b"} |
N/A (optional) | object (JSON) |
fields |
Return only selected fields | all fields (optional) | comma-separated string |
limit |
Maximum number of rows to return | 100 (optional) | integer (max: 1000) |
offset |
Offset this number of rows | 0 (optional) | integer |
sort |
Comma-separated field names with ordering, e.g. fieldname1, fieldname2 desc |
N/A (optional) | string |
include_total |
Include total matching record count | true (optional) | boolean |
Example Requests
Basic Request:
-
With Pagination:
-
With Filtering:
-
With Sorting:
-
Response Format
{
"success": true,
"result": {
"resource_id": "uuid-here",
"resource_name": "File Title",
"fields": [
{"id": "column1", "type": "text"},
{"id": "column2", "type": "integer"}
],
"records": [
{"_id": 1, "column1": "value1", "column2": 100},
{"_id": 2, "column1": "value2", "column2": 200}
],
"total": 150,
"limit": 100,
"offset": 0,
"_links": {
"self": "...",
"next": "...",
"prev": null
}
}
}