Data types
Updated
Results returned for data type polls against the API will return information in one of the formats outlined below.
These docs are still being populated with information. If you have any questions, don't hesitate to get in touch.
Result payload
Attributes
The root structure of the data JSON payload has the following attributes.
| name | type | description |
|---|---|---|
data |
list of data objects | The data retrieved from the source. |
metadata |
metadata object | Metadata related to data. |
Metadata
Attributes
| name | type | description |
|---|---|---|
count |
int | The number of objects in data. |
Files
The file data type is seen throughout the API, as it is a reference to a file that can be downloaded from the API through a files type poll.
Attributes
| name | type | description |
|---|---|---|
id |
string | Identifier used to request the file from the API. The value is only guaranteed to be unique in the scope of the current source. |
data_type |
string, always file |
Data type specifier. |
name |
string | The name of the file, excluding the extension. |
extension |
string, optional | The extension of the file if available. |
mime_type |
string, optional | The MIME type of the file if available. |
size |
int, optional | The size of the file if available. |
checksum |
string, optional | The md5 checksum if available. |
Example
{ "id": "abc123", "data_type": "file", "name": "IMG_0003", "extension": "jpg", "mime_type": "image/jpeg", "size": 2505426, }
Images
Extends files.
| name | type | description |
|---|---|---|
file_name |
string | The original file name of the file. The extension in this filename need to match the extension of the file. |
file_path |
string | The path of the file relative to other files within its service. For example, the path within a backup. |
width |
int, optional | The width of the file if available. |
height |
int, optional | The height of the file if available. |
Example
{ "id": "abc123", "data_type": "image", "file_name": "IMG_0003.JPG", "file_path": "Media/DCIM/100APPLE/IMG_0003.JPG", "name": "IMG_0003", "extension": "jpg", "mime_type": "image/jpeg", "width": 3000, "height": 2002, "size": 2505426, }
Videos
Extends files.
| name | type | description |
|---|---|---|
file_name |
string | The original file name of the file. The extension in this filename need to match the extension of the file. |
file_path |
string | The path of the file relative to other files within its service. For example, the path within a backup. |
width |
int, optional | The width of the file if available. |
height |
int, optional | The height of the file if available. |
duration |
int, optional | The length of the video if available. |
Example
{ "id": "abc123", "data_type": "image", "file_name": "IMG_0009.MOV", "file_path": "Media/DCIM/100APPLE/IMG_0009.MOV", "name": "IMG_0009", "extension": "mov", "mime_type": "video/quicktime", "width": 1920, "height": 1080, "size": 5421796, "duration": 9.135623 }
Messages
Attributes
| name | type | description |
|---|---|---|
id |
string | A unique identifier for the message. Use this to deduplicate returned data if necessary. |
data_type |
string, always message |
Data type specifier. |
conversation_id |
string | Identifier grouping messages by conversation. |
date |
datetime | When the message was sent or received. |
text |
string | The body of the message. |
from_me |
bool | Whether the message was sent or received. |
handle |
string | The 2nd party of the conversation. |
attachments |
list of files, optional | An array of file_id values which can be used with the download_file method. If the message includes no attachment, an empty array is returned. |
group_handles |
list of strings, optional | This value is null for person-to-person messages, and in group conversations is an array of strings representing phone numbers or iMessage email addresses. |
group |
string, optional | The name of the group at the time the message was sent. |
group_id |
string, optional | The unique identifier for the group within the context of that app. This may not be an integer, and if present, only provides information in addition to conversation_id. |
group_contacts |
string, optional | An array of objects referencing iOS contacts in the group. |
user |
string, optional | The user of the messaging app in the case where multiple users/accounts may be using a messaging app from the device. |
type |
string, optional | Used when a messaging service handles a variety of message types. For example SMS and iMessage in the case of iOS Messages. |
deleted |
bool, optional | A boolean value to indicate whether the message had been deleted. |
contact |
nested contact, optional | An object referencing an iOS contact of the 2nd party of the conversation. |
Example
{ "id": 6, "data_type": "message", "type": "SMS", "conversation_id": "vodafone", "handle": "vodafone", "from_me": false, "group_handles": [ "+441234567890", "renate@reincubate.com" ], "text": "Hi from Vodafone!", "attachments": [], "deleted": false, "date": "2015-10-28 09:18:17.000000" }
Contacts
Example
{ "id": "89CFD201-817E-4D8B-B1E1-18F4B737E889", "first_name": "John", "last_name": "Appleseed", "middle_name": "", "nickname": null, "prefix": "", "suffix": "", "birthday": "1980-06-22 00:00:00.000000", "note": "College roommate", "organisation": null, "department": null, "job_title": null, "records": [ { "type": "Phone", "name": "Cell", "value": "888-555-5512" }, { "type": "Phone", "name": "Home", "value": "888-555-1212" }, { "type": "Email", "name": "Internet", "value": "John-Appleseed@mac.com" }, { "type": "Address", "name": "Work", "City": "Atlanta", "ZIP": "30303", "Country": "USA", "CountryCode": "US", "State": "GA", "Street": "3494 Kuhl Avenue" }, { "type": "Address", "name": "Home", "City": "Atlanta", "ZIP": "30303", "Country": "USA", "CountryCode": "US", "State": "GA", "Street": "1234 Laurel Street" } ], "created": "2018-10-30 11:57:39.000000", "modified": "2018-10-30 11:57:39.000000" }
Calls
{ "id": "24116c5b16b85217", "data_type": "call", "duration": 5.131359, "answered": false, "from_me": true, "date": "2015-07-20 10:23:27.538011", "address": "07123456789", "call_type": "Phone" }
Calendar entries
Notes
{ "title": "Monday meeting:", "note": "Monday meeting:\n Discuss X,\n discuss Y.", "summary": null, "folder": "icloud", "sub_folder": "work", "attachments": [ { "type": "image", "file_id": "8e22cf6e524357b4eb3da775d193072ebba9543f", "file_path": "Media/80DDDEAD-B33F-37B2-7219432C0359/Image.jpeg" } ], "creation_date": "2016-06-06 13:23:20.000000", "last_modified": "2016-06-07 15:21:25.000000" }
Browser history entries
{ "url": "http://www.amazon.co.uk/", "last_visit": "2015-09-10 10:30:53.413244", "title": "Amazon.co.uk: Low Prices in Electronics, Books, Sports Equipment & more" }
Locations
{ "id": "", "latitude": 51.51440460583699, "longitude": -0.09058943950483185, "altitude": 0.0, "positioning_type": "Wifi", "horizontal_accuracy": 65.0, "vertical_accuracy": 0.0, "date_created": "2017-07-31T11:47:01.883000" }
