Application Settings - Dump Data
Dump Data
Dumps all the data stored in the Application's settingsParameter Name | Default Value | Required | Description |
application_id | NULL | True | The ID of the Application |
secret_key | NULL | True | The Application's Secret Key |
access_token | NULL | True | The Access Token for the authenticated user |
include_meta | NULL | False | If set to True or 1 the results will include the metadata of the variables |
Example Success Response
{
"success": true,
"response_code": 200,
"results": {
"int_test": 50,
"array_example": {
"foo": "bar",
"bar": false
},
"list_example": [
"foo",
"bar",
"bar",
"bar",
"bar",
"bar",
"bar",
"bar",
"bar"
]
}
}
Example Success Response with metadata
When you provide theinclude_meta
parameter with the value set to
True or 1 then the results will contain the metadata of the variables
{
"success": true,
"response_code": 200,
"results": {
"int_test": {
"type": "integer",
"value": 50,
"created_timestamp": 1608239452,
"last_updated_timestamp": 1608239452,
"size": 19
},
"array_example": {
"type": "array",
"value": {
"foo": "bar",
"bar": false
},
"created_timestamp": 1608242880,
"last_updated_timestamp": 1608242901,
"size": 32
},
"list_example": {
"type": "list",
"value": [
"foo",
"bar",
"bar",
"bar",
"bar",
"bar",
"bar",
"bar",
"bar"
],
"created_timestamp": 1608243116,
"last_updated_timestamp": 1608243116,
"size": 55
}
}
}
Metadata Results Structure
Name | Type | Description |
type | string | The type of the variable |
value | mixed | The value of the variable, the type for this can differ depending on the variable type |
created_timestamp | integer | The Unix Timestamp for when this variable was created |
last_updated_timestamp | integer | The Unix Timestamp for when this variable was last updated |
size | integer | The size that this variable takes up (including it's metadata) in bytes |