Using the PDX API

Python example 🔗︎ click to copy

Postman example 🔗︎ click to copy

Example Response 🔗︎ click to copy

A successful update request via PUT will return a status code of 200 OK and echo the updated fields. For example:

{
    "success": "1",
    "transaction": {
        "field_personal_marital_status": "Divorced"
    }
}

If unsuccessful, the 'success' attribute in the response will be '0'.

Creating a new row 🔗︎ click to copy

If the PDS dataset has no records eg. returns an empty array when making a GET request to the API, you will need to create a row.

Adding an entirely new set of values for an empty dataset is performed via POST HTTP method requests to the PDX API.

Example API Requests 🔗︎ click to copy

PHP example 🔗︎ click to copy

Python example 🔗︎ click to copy

Postman example 🔗︎ click to copy

If successful, the API will return the following response:

{
    "success": "1",
    "last_insert_id": "1"
}

Note: you will need to use the value of 'last_insert_id' when updating the dataset. For Metadata datasets this will normally always be '1'.

Transactional Datasets 🔗︎ click to copy

Retrieving Data 🔗︎ click to copy

Retrieving rows of transactional data is performed via GET HTTP method requests to the PDX API.

Example API Requests 🔗︎ click to copy

PHP example 🔗︎ click to copy

Python example 🔗︎ click to copy

Postman example 🔗︎ click to copy

Example Response 🔗︎ click to copy

{
   "1":{
      "id":"1",
      "browsing_history_url":"http://www.youtube.com",
      "browsing_history_title":"YouTube",
      "browsing_history_visit_date":"1397550508"
   },
   "2":{
      "id":"2",
      "browsing_history_url":"http://www.youtube.com",
      "browsing_history_title":"YouTube",
      "browsing_history_visit_date":"1397550512"
   }
}

Adding Data 🔗︎ click to copy

Adding a new row to a transactional dataset is performed via POST HTTP method requests to the PDX API.

The key changes when adding a transactional dataset are outlined in the table above.

Example API Requests 🔗︎ click to copy

PHP example 🔗︎ click to copy

Python example 🔗︎ click to copy

Postman example 🔗︎ click to copy

Example Response 🔗︎ click to copy

A successful request will return a HTTP status code of 200 OK and the line {"success":1}. If unsuccessful, the 'success' attribute in the response will be '0'.

Adding Batch Data 🔗︎ click to copy

If you wish to batch-send multiple rows of data in a single request, then you can POST a nested array of data in the request body. The raw JSON would look like this:

{
   "ds_energy_consumption": [
      {
         "created_timestamp": "1641909333",
         "field_energy_homeid": "1",
         "field_energy_reading_timestamp": "1648633780",
         "field_energy_reading_value": "1123.25",
         "field_energy_source_index_id": "1",
         "field_energy_source_name": "Kettle",
         "field_energy_source_type": "CAD",
         "updated_timestamp": "1641909333"
      },
      {
         "created_timestamp": "1641909333",
         "field_energy_homeid": "1",
         "field_energy_reading_timestamp": "1648633780",
         "field_energy_reading_value": "1153.50",
         "field_energy_source_index_id": "1",
         "field_energy_source_name": "Kettle",
         "field_energy_source_type": "CAD",
         "updated_timestamp": "1641909333"
      }
   ]
}

Example Batch API Requests 🔗︎ click to copy

PHP example 🔗︎ click to copy

Python example 🔗︎ click to copy

Postman example 🔗︎ click to copy

Note: there is a limit of 1000 rows of data per batch request.

The request is exactly the same as the one above except we now have a nested array in the data payload. The parameters and endpoints are the same as adding data.

Updating Data 🔗︎ click to copy

Updating values for an existing row in a transactional dataset is performed via PUT HTTP method requests to the PDX API.

Example API Requests 🔗︎ click to copy

PHP example 🔗︎ click to copy

Python example 🔗︎ click to copy

Postman example 🔗︎ click to copy