Data Structure

Sample data format

When a user consents to your app accessing their data, the digi.me API will asynchronously prepare that data for download. The data will be made available in a series of files and each filename will describe the kind of data that is available in it.

A sample response might look like this:

[18_1_1_1_1_D201504_0.json, 18_1_1_1_2_D201504_0.json, 18_1_1_1_7_D201504_0.json, 18_1_1_1_1_D201505_0.json, ...]

The filenames follow this naming convention:

{VersionInfo}_{ServiceGroup}_{ServiceType}_{Account_ID}_{ObjectType}_{DateRange}_{/}.json

So the file 18_1_1_1_1_D201504_0.json would represent:

{v18}_{Social}_{Facebook}_{Account_1}_{Posts}_{April2015}_{0}.json

The following shows a single object which is returned as part of an array describing a single Tweet

{
	"annotation": "",
	"baseid": "3_14193152_591913169108467712",
	"commentcount": 0,
	"createddate": 1429958071000,
	"entityid": "3_14193152_591913169108467712",
	"favouritecount": 2,
	"iscommentable": 0,
	"isfavourited": 1,
	"islikeable": 0,
	"islikes": 0,
	"isshared": 1,
	"istruncated": 0,
	"longitude": 0,
	"latitude": 0,
	"likecount": 0,
	"originalcrosspostid": "",
	"originalpostid": "",
	"originalposturl": "",
	"personentityid": "3_14193152_16257994",
	"personfilerelativepath": "",
	"personfileurl": "https://pbs.twimg.com/profile_images/1214965632/091221_07_Jules__1__normal.jpg",
	"personfullname": "Julian Ranger",
	"personusername": "rangerj",
	"postentityid": "",
	"postid": "591913169108467712",
	"postreplycount": 0,
	"posturl": "https://twitter.com/rangerj/status/591913169108467712",
	"rawtext": "",
	"referenceentityid": "3_14193152",
	"referenceentitytype": 15,
	"sharecount": 5,
	"socialnetworkuserentityid": "3_14193152",
	"source": "<a href=\"http://twitter.com/download/android\" rel=\"nofollow\">Twitter for Android</a>",
	"text": "Just installed our @digime boards in @DigitalCatapult as an IoT exemplar http://t.co/B9LzUOMskX",
	"title": "",
	"type": 6,
	"updateddate": 1429958071000,
	"viewcount": 0,
	"visibility": ""
}

It is a status update with a picture by Julian Ranger (@rangerj) with 5 retweets (sharecount) and 2 likes (favouritecount) uploaded using Twitter for Android (source) with the status update under (text).

See how we map service data to JSON objects

Download our Consent Access example objects