API object reference

BETA documentation generated on: December 06th 2018

Service ID: 1 - Social

Object ID: 1 - Media

Field
Data Type
Description
Example
baseid
string
Internal index used by digi.me
"4_1542271900260495153_182042"
cameramodelentityid
string
Internal index used by digi.me
commentcount
number
commententityid
string
Internal index used by digi.me
createddate
number
Created date, expressed as a unix timestamp
1498073159000
description
string
displayshorturl
string
displayurlindexend
number
displayurlindexstart
number
entityid
string
Internal index used by digi.me
"4_1542271900260495153_182042"
filter
string
"Gingham"
interestscore
number
itemlicenceentityid
string
Internal index used by digi.me
latitude
number
likecount
number
14
link
string
"https://www.instagram.com/p/BVnQB86F-8xlEERyS_PisN_g2p5-V-o3aUBd7A0/"
locationentityid
string
Internal index used by digi.me
longitude
number
mediaalbumentityid
string
Internal index used by digi.me
"4_182042_182042_1"
mediaalbumname
string
mediaid
string
"1542271900260495153_182042"
mediaobjectid
string
mediaobjectlikeid
string
name
string
"Team"s getting smaller by 1. Good luck @mheap"
originatortype
number
2
personentityid
string
Internal index used by digi.me
"4_182042_182042"
personfilerelativepath
string
personfileurl
string
"https://scontent.cdninstagram.com/t51.2885-19/11356960_1625044604420020_264796266_a.jpg"
personfullname
string
"Pascal Wheeler"
personusername
string
"pascalw"
postentityid
string
Internal index used by digi.me
"4_182042_1542271900260495153_182042"
resources
Internal Object reference
[
   {
      "aspectratio": {
         "accuracy": 100,
         "actual": "1:1",
         "closest": "1:1"
      },
      "height": 150,
      "mimetype": "image/jpeg",
      "type": 0,
      "url": "https://scontent.cdninstagram.com/t51.2885-15/s150x150/e35/c135.0.809.809/19367043_122168111710592_7572307112722694144_n.jpg",
      "width": 150
   },
   {
      "aspectratio": {
         "accuracy": 99.581589958159,
         "actual": "320:239",
         "closest": "4:3"
      },
      "height": 239,
      "mimetype": "image/jpeg",
      "type": 0,
      "url": "https://scontent.cdninstagram.com/t51.2885-15/s320x320/e35/19367043_122168111710592_7572307112722694144_n.jpg",
      "width": 320
   }
]
tagcount
number
taggedpeoplecount
number
type
number
updateddate
number
Updated date, express as a unix timestamp
1498073159000

Object ID: 2 - Post

Field
Data Type
Description
Example
annotation
string
baseid
string
Internal index used by digi.me
"4_182042_1542271900260495153_182042"
cameramodelentityid
string
Internal index used by digi.me
commentcount
number
commententityid
string
Internal index used by digi.me
createddate
number
Created date, expressed as a unix timestamp
1498073159000
description
string
entityid
string
Internal index used by digi.me
"4_182042_1542271900260495153_182042"
favouritecount
number
iscommentable
number
1
isfavourited
number
islikeable
number
1
islikes
number
isshared
number
istruncated
number
latitude
number
likecount
number
14
longitude
number
originalcrosspostid
number
originalpostid
number
originalposturl
string
personentityid
string
Internal index used by digi.me
"4_182042_182042"
personfilerelativepath
string
personfileurl
string
"https://scontent.cdninstagram.com/t51.2885-19/11356960_1625044604420020_264796266_a.jpg"
personfullname
string
"Pascal Wheeler"
personusername
string
"pascalw"
postentityid
string
Internal index used by digi.me
postid
string
"1542271900260495153_182042"
postreplycount
number
posturl
string
"https://www.instagram.com/p/BVnQB86F-8xlEERyS_PisN_g2p5-V-o3aUBd7A0/"
rawtext
string
referenceentityid
string
Internal index used by digi.me
"4_182042"
referenceentitytype
number
15
sharecount
number
socialnetworkuserentityid
string
Internal index used by digi.me
"4_182042"
source
string
text
string
"Team"s getting smaller by 1. Good luck @mheap"
title
string
type
number
20
updateddate
number
Updated date, express as a unix timestamp
1498073159000
visibility
string

Object ID: 7 - Comment

Field
Data Type
Description
Example
appid
string
baseid
string
Internal index used by digi.me
"4_182042_17858982733161786"
commentcount
number
commentid
string
"17858982733161786"
commentreplyid
string
Links to a parent comment (by Comment.commentid) where the post is a reply
createddate
number
Created date, expressed as a unix timestamp
1497373638000
entityid
string
Internal index used by digi.me
"4_182042_17858982733161786"
likecount
number
link
string
metaid
string
personentityid
string
Internal index used by digi.me
"4_182042_1545946064"
personfilerelativepath
string
personfileurl
string
"https://scontent.cdninstagram.com/t51.2885-19/s150x150/19051047_1129050077200786_761246497533591552_a.jpg"
personfullname
string
"Sarah Lamb"
personusername
string
"iamgirlygeekdom"
privacy
number
referenceentityid
string
Internal index used by digi.me
"4_1536332454209789316_182042"
referenceentitytype
number
1
socialnetworkuserentityid
string
Internal index used by digi.me
"4_182042"
text
string
"Oooh I missed out! Mint magnums are my favourite!"
updateddate
number
Updated date, express as a unix timestamp
1497373638000

Service ID: 2 - Medical

Object ID: 127 - Allergy Intolerance

Field
Data Type
Is Required
Example
accountentityid
string
"16_3003765099"
asserteddate
number
true
1449247364000
baseid
string
clinicalstatus
string
true
code
true
{
   "text": "1234568790123456879012345687901234568790123456879012345687901234568790123456879012345687901234568790",
   "coding": [
      {
         "display": "efnaofnæmi"
      }
   ]
}
createddate
number
1449247364000
criticality
string
true
entityid
string
true
"16_3003765099_127_1449247364000_"
id
string
true
identifier
true
lastoccurence
number
true
note
true
[
   {
      "text": [

      ]
   }
]
onsetdatetime
number
true
reaction
true
recorder
true
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
updateddate
number
verificationstatus
string
true

Object ID: 128 - Condition

Field
Data Type
Is Required
Example
accountentityid
string
"20_tukrxl29bxe9lyacdtiyrwc6ln5gz-z7clr2r-2sy964b"
asserteddate
number
true
1446854400000
asserter
true
{
   "display": "moore, sean",
   "reference": "https://open-ic.epic.com/fhir/api/fhir/dstu2/practitioner/titwfhjchtlo0pfh9nzctsqb"
}
baseid
string
category
true
[
   {
      "text": "diagnosis",
      "coding": [
         {
            "system": "http://loinc.org",
            "code": "29308-4",
            "display": "diagnosis"
         },
         {
            "system": "http://snomed.info/sct",
            "code": "439401001",
            "display": "diagnosis"
         },
         {
            "system": "http://hl7.org/fhir/condition-category",
            "code": "diagnosis",
            "display": "diagnosis"
         },
         {
            "system": "http://argonautwiki.hl7.org/extension-codes",
            "code": "problem",
            "display": "problem"
         }
      ]
   }
]
clinicalstatus
string
true
code
true
{
   "text": "dog bite",
   "coding": [
      {
         "system": "urn:oid:2.16.840.1.113883.6.90",
         "code": "w54.0xxa",
         "display": "dog bite"
      },
      {
         "system": "http://snomed.info/sct",
         "code": "283734005",
         "display": "dog bite - wound (disorder)"
      }
   ]
}
createddate
number
1446854400000
entityid
string
true
"20_tukrxl29bxe9lyacdtiyrwc6ln5gz-z7clr2r-2sy964b_tt4fnwwh8zm2zgwsbocyvuab"
id
string
true
"tt4fnwwh8zm2zgwsbocyvuab"
identifier
true
onsetdatetime
number
true
1446854400000
referenceentityid
string
referenceentitytype
number
severity
true
{
   "text": "medium",
   "coding": [
      {
         "system": "urn:oid:2.16.840.1.113883.6.90",
         "code": "w54.0xxa",
         "display": "dog bite"
      },
      {
         "system": "http://snomed.info/sct",
         "code": "283734005",
         "display": "dog bite - wound (disorder)"
      }
   ]
}
socialnetworkuserentityid
string
updateddate
number
verificationstatus
string
true

Object ID: 129 - Immunization

Field
Data Type
Is Required
Example
accountentityid
string
"16_3003765099"
baseid
string
createddate
number
1089158400000
date
number
true
1089158400000
encounter
true
{
   "entityid": "16_3003765099_136_27987",
   "createddate": 1274107221000,
   "accountentityid": "16_3003765099",
   "period": {
      "start": 1275319680000
   },
   "id": "27987",
   "participant": [
      {
         "individual": {
            "identifier": {
               "value": "raxx0761"
            }
         }
      }
   ],
   "location": [
      {
         "location": {
            "description": "sögu dev skema"
         }
      }
   ],
   "serviceprovider": {
      "name": "saga_skema - tms"
   },
   "type": [
      {
         "coding": [
            {
               "code": "56092"
            }
         ]
      }
   ],
   "class": {
      "code": "emer",
      "display": "emergency"
   }
}
entityid
string
true
"16_3003765099_129_j07bd52"
id
string
true
identifier
true
lotnumber
string
true
notgiven
boolean
true
note
true
referenceentityid
string
referenceentitytype
number
route
true
site
true
socialnetworkuserentityid
string
status
string
true
updateddate
number
vaccinationprotocol
true
[
   {
      "targetdisease": [
         {
            "coding": [
               {
                  "code": " ",
                  "display": "mislingar"
               }
            ],
            "text": "mislingar"
         },
         {
            "coding": [
               {
                  "code": " ",
                  "display": "hettusótt"
               }
            ],
            "text": "hettusótt"
         },
         {
            "coding": [
               {
                  "code": " ",
                  "display": "rauðir hundar"
               }
            ],
            "text": "rauðir hundar"
         }
      ]
   }
]
vaccinecode
true
{
   "text": "priorix® misl + hettus + r. hund / mmr",
   "coding": [
      {
         "code": "j07bd52",
         "display": "priorix® misl + hettus + r. hund / mmr",
         "system": "atc"
      }
   ]
}

Object ID: 130 - Medication Request

Field
Data Type
Is Required
Example
accountentityid
string
"16_3003765099"
authoredon
number
true
baseid
string
createddate
number
-621355968000
dispenserequest
true
{
   "validityperiod": {
      "start": -621355968000,
      "end": 1500163200000
   },
   "numberofrepeatsallowed": "0"
}
dosageinstruction
true
[
   {
      "dosequantity": {
         "unit": "mg",
         "value": 10
      },
      "text": "2 töflur á dag",
      "sequence": 0
   }
]
entityid
string
true
"16_3003765099_130_-621355968000_n06ab05"
id
string
true
identifier
true
medicationreference
true
{
   "code": {
      "text": "seroxat"
   },
   "form": {
      "text": "mixt.kyr"
   },
   "package": {
      "container": {
         "text": "0"
      },
      "content": [
         {
            "amount": {
               "value": "100",
               "unit": null
            }
         }
      ]
   }
}
note
true
recorder
true
referenceentityid
string
referenceentitytype
number
requester
true
socialnetworkuserentityid
string
status
string
true
updateddate
number
1499040000000

Object ID: 131 - Family Member History

Field
Data Type
Is Required
Example
accountentityid
string
"20_tukrxl29bxe9lyacdtiyrwc6ln5gz-z7clr2r-2sy964b"
baseid
string
condition
true
[
   {
      "onsetstring": "12",
      "code": {
         "text": "vitiligo"
      },
      "note": {
         "text": "also went by alias \"uncle ruckus\""
      }
   }
]
createddate
number
1459987200000
date
number
true
1459987200000
deceasedboolean
boolean
true
false
entityid
string
true
id
string
true
identifier
true
name
string
true
"joe"
referenceentityid
string
referenceentitytype
number
relationship
true
{
   "text": "brother",
   "coding": [
      {
         "system": "http://hl7.org/fhir/valueset/v3-familymember",
         "code": "bro",
         "display": "brother"
      }
   ]
}
socialnetworkuserentityid
string
status
string
true
"partial"
updateddate
number

Object ID: 132 - Observation

Field
Data Type
Is Required
Example
accountentityid
string
"16_3003765099"
baseid
string
category
true
[
   {
      "text": "priorix® misl + hettus + r. hund / mmr",
      "coding": [
         {
            "system": 1722
         }
      ]
   }
]
code
true
comment
string
true
""
component
true
createddate
number
1505232000000
effectivedatetime
number
true
1505232000000
entityid
string
true
"16_3003765099_132_1722"
id
string
true
"1722"
identifier
true
interpretation
true
issued
number
true
1518192086560
performer
true
[
   {
      "display": "moore, sean",
      "reference": "https://open-ic.epic.com/fhir/api/fhir/dstu2/practitioner/titwfhjchtlo0pfh9nzctsqb",
      "patient": {
         "id": "3003765099",
         "name": [
            {
            }
         ]
      }
   }
]
referenceentityid
string
referenceentitytype
number
referencerange
true
socialnetworkuserentityid
string
status
string
true
updateddate
number
1518192086560
valueboolean
boolean
true
valuecodeableconcept
true
valuequantity
true
{
   "value": 36.8
}
valuerange
true
{
   "high": {
      "value": 0,
      "unit": ""
   },
   "low": {
      "value": 0,
      "unit": ""
   }
}
valueratio
true
valuestring
string
true
"36,8"

Object ID: 133 - Procedure

Field
Data Type
Is Required
Example
accountentityid
string
"20_tukrxl29bxe9lyacdtiyrwc6ln5gz-z7clr2r-2sy964b"
baseid
string
code
true
{
   "text": "eye exam",
   "coding": [
      {
         "system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.696580",
         "code": "40707",
         "display": "eye exam"
      }
   ]
}
createddate
number
1444159200000
entityid
string
true
"20_tukrxl29bxe9lyacdtiyrwc6ln5gz-z7clr2r-2sy964b_t5lc5zmmcn1ipoojr0hhgomdj2j97qp4is2elboi51w4b"
id
string
true
"t5lc5zmmcn1ipoojr0hhgomdj2j97qp4is2elboi51w4b"
identifier
true
[
   {
      "use": "usual",
      "system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.696580",
      "value": "40707"
   }
]
location
true
notdone
boolean
true
false
performeddatetime
number
true
1444159200000
performer
true
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
status
string
true
"completed"
updateddate
number

Object ID: 134 - Diagnostic Report

Field
Data Type
Is Required
Example
accountentityid
string
"20_tukrxl29bxe9lyacdtiyrwc6ln5gz-z7clr2r-2sy964b"
baseid
string
code
true
{
   "text": "eye exam",
   "coding": [

   ]
}
createddate
number
1444159200000
effectivedatetime
number
true
1444159200000
entityid
string
true
"20_tukrxl29bxe9lyacdtiyrwc6ln5gz-z7clr2r-2sy964b_tgb4cdorewzfnemd5sbcqpab"
id
string
true
"tgb4cdorewzfnemd5sbcqpab"
identifier
true
[
   {
      "use": "official",
      "system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.798268",
      "value": "975888"
   }
]
issued
number
true
1444159200000
performer
true
{
   "actor": {
      "display": "physician adolescent",
      "reference": "https://open-ic.epic.com/fhir/api/fhir/dstu2/practitioner/tfpkggbo9haiyymhtol5qwab"
   }
}
referenceentityid
string
referenceentitytype
number
result
true
[
   {
      "createddate": 1505232000000,
      "effectivedatetime": 1505232000000,
      "issued": 1518192086560,
      "updateddate": 1518192086560,
      "accountentityid": "16_3003765099",
      "entityid": "16_3003765099_132_1722",
      "comment": "",
      "valuerange": {
         "high": {
            "value": 0,
            "unit": ""
         },
         "low": {
            "value": 0,
            "unit": ""
         }
      },
      "id": "1722",
      "valuestring": "36,8",
      "performer": [
         {
            "patient": {
               "id": "3003765099",
               "name": [
                  {
                  }
               ]
            }
         }
      ],
      "valuequantity": {
         "value": 36.8
      },
      "category": [
         {
            "coding": [
               {
                  "system": 1722
               }
            ],
            "text": ""
         }
      ],
      "display": "component: bicarbonate [mmol/l] in arterial blood",
      "reference": "https://open-ic.epic.com/fhir/api/fhir/dstu2/observation/tp3gv6pob3cmjt9myquqglisjf0i.vgyinudzbto1eyib"
   }
]
socialnetworkuserentityid
string
status
string
true
"final"
subject
true
updateddate
number

Object ID: 135 - Device

Field
Data Type
Is Required
Example
accountentityid
string
baseid
string
createddate
number
entityid
string
true
expirationdate
number
true
id
string
true
identifier
true
model
string
true
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
status
string
true
type
true
udi
UDI
true
updateddate
number

Object ID: 136 - Encounter

Field
Data Type
Is Required
Example
accountentityid
string
"16_3003765099"
baseid
string
class
true
{
   "code": "emer",
   "display": "emergency"
}
createddate
number
1274107221000
entityid
string
true
"16_3003765099_136_27987"
id
string
true
"27987"
identifier
true
location
true
[
   {
      "location": {
         "name": "saga_skema - tms"
      }
   }
]
participant
true
[
   {
      "individual": {
         "practitioner": {
            "name": [
               {
                  "text": "ake lindell pain"
               }
            ]
         }
      }
   }
]
period
true
{
   "start": 1275319680000
}
priority
true
referenceentityid
string
referenceentitytype
number
serviceprovider
true
{
   "name": "saga_skema - tms"
}
socialnetworkuserentityid
string
status
string
true
type
true
[
   {
      "text": "eye exam",
      "coding": [
         {
            "code": "56092"
         }
      ]
   }
]
updateddate
number

Object ID: 137 - Medication Dispense

Field
Data Type
Is Required
Example
accountentityid
string
"16_3003765099"
baseid
string
createddate
number
dosageinstruction
true
[
   {
      "dosequantity": {
         "unit": "mg/ml",
         "value": 50
      },
      "text": "takist eftir þörfum",
      "sequence": 0
   }
]
entityid
string
true
"16_3003765099_137_1448021708000_j01ca04"
id
string
true
identifier
true
medicationcodeableconcept
true
medicationreference
true
{
   "code": {
      "coding": [
         {
            "code": "j01ca04"
         },
         {
            "code": "600999"
         },
         {
            "code": "969438"
         }
      ],
      "text": "amoxicillin sandoz"
   },
   "form": {
      "text": "mixt.kyr"
   },
   "package": {
      "container": {
         "text": "0"
      },
      "content": [
         {
            "amount": {
               "value": "100",
               "unit": null
            }
         }
      ]
   }
}
notdone
boolean
true
note
true
[
   {
      "text": [

      ]
   }
]
performer
true
quantity
true
{
   "value": 1
}
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
status
string
true
updateddate
number
whenhandedover
number
true
whenprepared
number
true

Object ID: 139 - Patient

Field
Data Type
Is Required
Example
accountentityid
string
active
boolean
true
address
true
baseid
string
birthdate
number
true
communication
true
contact
true
createddate
number
deceasedboolean
boolean
true
deceaseddatetime
number
true
entityid
string
true
gender
string
true
id
string
true
identifier
true
maritalstatus
true
name
true
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
telecom
true
updateddate
number

Service ID: 3 - Finance

Object ID: 201 - Transaction

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"17_10019612"
amount
number
2.43
basetype
string
"DEBIT"
category
string
"Restaurants"
categoryid
number
22
categorysource
string
"SYSTEM"
categorytype
string
"EXPENSE"
checknumber
string
consumerref
string
createddate
number
Created date, expressed as a unix timestamp
1490832000000
currency
string
"GBP"
entityid
string
Internal index used by digi.me
"17_10019612_10945571"
highlevelcategoryid
number
10000011
id
string
"10945571"
ismanual
boolean
merchantaddress1
string
merchantaddress2
string
merchantcity
string
merchantcountry
string
merchantid
string
"costacoffee"
merchantname
string
"Costa Coffee"
merchantstate
string
merchantzip
string
originalref
string
"Debit COSTA COFFEE ON 26 MAR CPM"
postdate
number
1490832000000
runningbalance
number
113.55
runningbalancecurrency
string
"GBP"
simpleref
string
"Costa Coffee"
status
string
"POSTED"
subtype
string
"PURCHASE"
transactiondate
number
type
string
"PURCHASE"

Service ID: 4 - Health & Fitness

Object ID: 300 - Activity

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"18_4W73QJ"
activitylevel
Internal Object reference
[
   {
      "minutes": 0,
      "name": "sedentary"
   },
   {
      "minutes": 2,
      "name": "lightly"
   }
]
activityname
string
"Walk"
activitytypeid
string
"90013"
averageheartrate
number
119
calories
number
251
createddate
number
Created date, expressed as a unix timestamp
1475276448000
distance
number
durations
Internal Object reference
{
   "active": 1587000,
   "original": 1587000,
   "total": 1587000
}
elevationgain
number
entityid
string
Internal index used by digi.me
"18_4W73QJ_4268169673"
heartratezones
Internal Object reference
[
   {
      "max": 96,
      "min": 30,
      "minutes": 2,
      "name": "Out of Range"
   },
   {
      "max": 134,
      "min": 96,
      "minutes": 19,
      "name": "Fat Burn"
   }
]
id
string
"4268169673"
logtype
string
"auto_detected"
manualvaluesspecified
Internal Object reference
{
   "calories": false,
   "distance": false,
   "steps": false
}
originalstartdate
number
1475276448000
speed
number
steps
number
2303
updateddate
number
Updated date, express as a unix timestamp
1475278546000

Object ID: 301 - Daily Activity Summary

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"18_4W73QJ"
activescore
number
-1
activitycalories
number
636
caloriesbmr
number
1893
caloriesout
number
2519
createddate
number
Created date, expressed as a unix timestamp
1472601600000
distances
Internal Object reference
[
   {
      "activity": "total",
      "distance": 1.62
   },
   {
      "activity": "tracker",
      "distance": 1.62
   }
]
elevation
number
30.48
entityid
string
Internal index used by digi.me
"18_4W73QJ_1472601600000"
fairlyactiveminutes
number
floors
number
10
goals
Internal Object reference
{
   "activeminutes": 30,
   "caloriesout": 3082,
   "distance": 8.05,
   "floors": 10,
   "steps": 10000
}
heartratezones
Internal Object reference
[
   {
      "caloriesout": 2078.8569,
      "max": 96,
      "min": 30,
      "minutes": 1196,
      "name": "Out of Range"
   },
   {
      "caloriesout": 159.49737,
      "max": 134,
      "min": 96,
      "minutes": 32,
      "name": "Fat Burn"
   }
]
id
string
"1472601600000"
lightlyactiveminutes
number
147
marginalcalories
number
319
restingheartrate
number
64
sedentaryminutes
number
896
steps
number
2749
veryactiveminutes
number

Object ID: 302 - Achievement

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"18_3J8QQG"
category
string
"Daily Steps"
description
string
"35,000 steps in a day"
earnedmessage
string
"Congrats on earning your first Hiking Boot badge!"
entityid
string
Internal index used by digi.me
"18_3J8QQG_228TPW"
gradientendcolor
string
"FF677C"
gradientstartcolor
string
"D24958"
id
string
"228TPW"
marketingdescription
string
"You"ve walked 35,000 steps And
mobiledescription
string
"Woot, woot! There"s no mountain you can"t
name
string
"Hiking Boot (35,000 steps in a day)"
resources
Internal Object reference
[
   {
      "aspectratio": {
         "accuracy": 100,
         "actual": "1:1",
         "closest": "1:1"
      },
      "height": 100,
      "mimetype": "image/png",
      "type": 0,
      "url": "https://static0.fitbit.com/images/badges_new/100px/badge_daily_steps35k.png",
      "width": 100
   },
   {
      "aspectratio": {
         "accuracy": 100,
         "actual": "1:1",
         "closest": "1:1"
      },
      "height": 125,
      "mimetype": "image/png",
      "type": 0,
      "url": "https://static0.fitbit.com/images/badges_new/125px/badge_daily_steps35k.png",
      "width": 125
   }
]
sharetext
string
"I took 35,000 steps and earned
shortdescription
string
"35,000 steps"
shortname
string
"Hiking Boot"
timesachieved
number
1
type
string
"DAILY_STEPS"
updateddate
number
Updated date, express as a unix timestamp
1473984000000
value
number
35000

Object ID: 303 - Sleep

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"18_4W73QJ"
createddate
number
Created date, expressed as a unix timestamp
1472601600000
duration
number
24600000
efficiency
number
97
enddate
number
1472622240000
entityid
string
Internal index used by digi.me
"18_4W73QJ_12444346788"
id
string
"12444346788"
infocode
number
ismainsleep
boolean
levels
Internal Object reference
[
   {
      "createddate": 1472597610000,
      "level": "awake",
      "seconds": 180
   },
   {
      "createddate": 1472597790000,
      "level": "restless",
      "seconds": 120
   }
]
minutesafterwakeup
number
minutesasleep
number
398
minutesawake
number
12
minutestofallasleep
number
startdate
number
1472597610000
summary
Internal Object reference
{
   "asleep": {
      "count": 0,
      "minutes": 398
   },
   "awake": {
      "count": 1,
      "minutes": 3
   },
   "restless": {
      "count": 8,
      "minutes": 9
   }
}
timeinbed
number
410
type
string
"classic"

Service ID: 5 - Entertainment

Object ID: 404 - Saved Album

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an"
album
Internal Object reference
{
   "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
   "artists": [
      {
         "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
         "entityid": "19_xqonjx408hdv0e8upnvqg98an_4F0b9Cx0VIVVOLFgehonr6",
         "followerscount": 8252,
         "genres": [
            "turbo folk",
            "yugoslav rock"
         ],
         "id": "4F0b9Cx0VIVVOLFgehonr6",
         "link": "https://open.spotify.com/artist/4F0b9Cx0VIVVOLFgehonr6",
         "name": "Halid Bešlić",
         "popularity": 41,
         "resources": [
            {
               "aspectratio": {
                  "accuracy": 100,
                  "actual": "1:1",
                  "closest": "1:1"
               },
               "height": 640,
               "mimetype": "application/octet-stream",
               "type": 0,
               "url": "https://i.scdn.co/image/e7b3fe7ab8a6d76d3c3268a3b015904d8aa7054d",
               "width": 640
            },
            {
               "aspectratio": {
                  "accuracy": 100,
                  "actual": "1:1",
                  "closest": "1:1"
               },
               "height": 300,
               "mimetype": "application/octet-stream",
               "type": 0,
               "url": "https://i.scdn.co/image/89c0bb13286ab59fcf9f27d8ea3af4d0334357d3",
               "width": 300
            }
         ]
      }
   ],
   "availablemarkets": [

   ],
   "copyrights": [
      {
         "text": "1988 Jugoton/Gold AV",
         "type": "C"
      },
      {
         "text": "1988 Jugoton/Gold AV",
         "type": "P"
      }
   ],
   "entityid": "19_xqonjx408hdv0e8upnvqg98an_42tZWXpR9jtfgquaLf8OVb",
   "genres": [

   ],
   "id": "42tZWXpR9jtfgquaLf8OVb",
   "label": "Gold Audio Video",
   "link": "https://open.spotify.com/album/42tZWXpR9jtfgquaLf8OVb",
   "name": "Mostovi tuge",
   "popularity": 1,
   "releasedate": 567993600000,
   "resources": [
      {
         "aspectratio": {
            "accuracy": 100,
            "actual": "1:1",
            "closest": "1:1"
         },
         "height": 640,
         "mimetype": "application/octet-stream",
         "type": 0,
         "url": "https://i.scdn.co/image/6823c3d920ae1be705417f74c1d227018f50cb9c",
         "width": 640
      },
      {
         "aspectratio": {
            "accuracy": 100,
            "actual": "1:1",
            "closest": "1:1"
         },
         "height": 300,
         "mimetype": "application/octet-stream",
         "type": 0,
         "url": "https://i.scdn.co/image/47410d5c4760714133aebd62f3d5fc8375a608ef",
         "width": 300
      }
   ],
   "tracks": [
      {
         "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
         "artists": [
            {
               "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
               "entityid": "19_xqonjx408hdv0e8upnvqg98an_4F0b9Cx0VIVVOLFgehonr6",
               "id": "4F0b9Cx0VIVVOLFgehonr6",
               "link": "https://open.spotify.com/artist/4F0b9Cx0VIVVOLFgehonr6",
               "name": "Halid Bešlić"
            }
         ],
         "availablemarkets": [

         ],
         "discnumber": 1,
         "duration": 193453,
         "entityid": "19_xqonjx408hdv0e8upnvqg98an_7rBTPxrnwpnZbnQoTqE3mg",
         "explicit": false,
         "id": "7rBTPxrnwpnZbnQoTqE3mg",
         "link": "https://open.spotify.com/track/7rBTPxrnwpnZbnQoTqE3mg",
         "name": "Mostovi tuge",
         "number": 1
      },
      {
         "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
         "artists": [
            {
               "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
               "entityid": "19_xqonjx408hdv0e8upnvqg98an_4F0b9Cx0VIVVOLFgehonr6",
               "id": "4F0b9Cx0VIVVOLFgehonr6",
               "link": "https://open.spotify.com/artist/4F0b9Cx0VIVVOLFgehonr6",
               "name": "Halid Bešlić"
            }
         ],
         "availablemarkets": [

         ],
         "discnumber": 1,
         "duration": 219360,
         "entityid": "19_xqonjx408hdv0e8upnvqg98an_69d0OcADV4x128JfkMqeeb",
         "explicit": false,
         "id": "69d0OcADV4x128JfkMqeeb",
         "link": "https://open.spotify.com/track/69d0OcADV4x128JfkMqeeb",
         "name": "Daleko je sreca",
         "number": 2
      }
   ],
   "type": "album"
}
createddate
number
Created date, expressed as a unix timestamp
1514454801000
entityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an_1514454801000_42tZWXpR9jtfgquaLf8OVb"
id
string
"1514454801000_42tZWXpR9jtfgquaLf8OVb"

Object ID: 405 - Saved Track

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an"
createddate
number
Created date, expressed as a unix timestamp
1520859957000
entityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an_1520859957000_52wm7k3WvWXdtmy5ijqyrA"
id
string
"1520859957000_52wm7k3WvWXdtmy5ijqyrA"
track
Internal Object reference
{
   "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
   "album": {
      "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
      "artists": [
         {
            "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
            "entityid": "19_xqonjx408hdv0e8upnvqg98an_0LyfQWJT6nXafLPZqxe9Of",
            "id": "0LyfQWJT6nXafLPZqxe9Of",
            "link": "https://open.spotify.com/artist/0LyfQWJT6nXafLPZqxe9Of",
            "name": "Various Artists"
         }
      ],
      "availablemarkets": [
         "AD",
         "AR"
      ],
      "copyrights": [
         {
            "text": "Croatia Records",
            "type": "C"
         },
         {
            "text": "Croatia Records",
            "type": "P"
         }
      ],
      "entityid": "19_xqonjx408hdv0e8upnvqg98an_4Tyb8HuDO4b47fuORGqdtq",
      "genres": [

      ],
      "id": "4Tyb8HuDO4b47fuORGqdtq",
      "label": "Croatia Records",
      "link": "https://open.spotify.com/album/4Tyb8HuDO4b47fuORGqdtq",
      "name": "40 Velikih Hitova (Opusti Se I Uživaj)",
      "popularity": 21,
      "releasedate": 1498608000000,
      "resources": [
         {
            "aspectratio": {
               "accuracy": 100,
               "actual": "1:1",
               "closest": "1:1"
            },
            "height": 640,
            "mimetype": "application/octet-stream",
            "type": 0,
            "url": "https://i.scdn.co/image/1be0cd93902f944a46f7b2c206ca9c52730d37bc",
            "width": 640
         },
         {
            "aspectratio": {
               "accuracy": 100,
               "actual": "1:1",
               "closest": "1:1"
            },
            "height": 300,
            "mimetype": "application/octet-stream",
            "type": 0,
            "url": "https://i.scdn.co/image/665b6803d9c89dc3e432e41cd1cfaf255b3af8d1",
            "width": 300
         }
      ],
      "type": "compilation"
   },
   "artists": [
      {
         "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
         "entityid": "19_xqonjx408hdv0e8upnvqg98an_60CQNohiJxVssiJysT2XOB",
         "followerscount": 2244,
         "genres": [
            "croatian pop",
            "yugoslav rock"
         ],
         "id": "60CQNohiJxVssiJysT2XOB",
         "link": "https://open.spotify.com/artist/60CQNohiJxVssiJysT2XOB",
         "name": "Magazin",
         "popularity": 34,
         "resources": [
            {
               "aspectratio": {
                  "accuracy": 100,
                  "actual": "1:1",
                  "closest": "1:1"
               },
               "height": 640,
               "mimetype": "application/octet-stream",
               "type": 0,
               "url": "https://i.scdn.co/image/1cc518fa0f772b75a58b095000d02cc9f026841b",
               "width": 640
            },
            {
               "aspectratio": {
                  "accuracy": 100,
                  "actual": "1:1",
                  "closest": "1:1"
               },
               "height": 300,
               "mimetype": "application/octet-stream",
               "type": 0,
               "url": "https://i.scdn.co/image/21fe53f2d40ae957445fa7fb0df576a6e10ed282",
               "width": 300
            }
         ]
      }
   ],
   "availablemarkets": [
      "AD",
      "AR"
   ],
   "discnumber": 1,
   "duration": 222533,
   "entityid": "19_xqonjx408hdv0e8upnvqg98an_52wm7k3WvWXdtmy5ijqyrA",
   "explicit": false,
   "id": "52wm7k3WvWXdtmy5ijqyrA",
   "link": "https://open.spotify.com/track/52wm7k3WvWXdtmy5ijqyrA",
   "name": "Kad Bi Bio Blizu",
   "number": 15,
   "popularity": 6,
   "resources": [
      {
         "duration": 30000,
         "mimetype": "audio/mp3",
         "type": 2,
         "url": "https://p.scdn.co/mp3-preview/f5006b1c23b8a7d3c2bc7f63edc2e627c0d24277?cid=8f62e65c31d74c15b9c8129505694ee1"
      }
   ]
}

Object ID: 406 - Play History

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an"
createddate
number
Created date, expressed as a unix timestamp
1516894740726
entityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an_1516894740726_15GzLqxP5RzZHx6aYkFbuJ"
id
string
"1516894740726_15GzLqxP5RzZHx6aYkFbuJ"
track
Internal Object reference
{
   "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
   "album": {
      "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
      "artists": [
         {
            "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
            "entityid": "19_xqonjx408hdv0e8upnvqg98an_0LyfQWJT6nXafLPZqxe9Of",
            "id": "0LyfQWJT6nXafLPZqxe9Of",
            "link": "https://open.spotify.com/artist/0LyfQWJT6nXafLPZqxe9Of",
            "name": "Various Artists"
         }
      ],
      "availablemarkets": [
         "AD",
         "AR"
      ],
      "copyrights": [
         {
            "text": "Croatia Records",
            "type": "C"
         },
         {
            "text": "Croatia Records",
            "type": "P"
         }
      ],
      "entityid": "19_xqonjx408hdv0e8upnvqg98an_4Tyb8HuDO4b47fuORGqdtq",
      "genres": [

      ],
      "id": "4Tyb8HuDO4b47fuORGqdtq",
      "label": "Croatia Records",
      "link": "https://open.spotify.com/album/4Tyb8HuDO4b47fuORGqdtq",
      "name": "40 Velikih Hitova (Opusti Se I Uživaj)",
      "popularity": 21,
      "releasedate": 1498608000000,
      "resources": [
         {
            "aspectratio": {
               "accuracy": 100,
               "actual": "1:1",
               "closest": "1:1"
            },
            "height": 640,
            "mimetype": "application/octet-stream",
            "type": 0,
            "url": "https://i.scdn.co/image/1be0cd93902f944a46f7b2c206ca9c52730d37bc",
            "width": 640
         },
         {
            "aspectratio": {
               "accuracy": 100,
               "actual": "1:1",
               "closest": "1:1"
            },
            "height": 300,
            "mimetype": "application/octet-stream",
            "type": 0,
            "url": "https://i.scdn.co/image/665b6803d9c89dc3e432e41cd1cfaf255b3af8d1",
            "width": 300
         }
      ],
      "type": "compilation"
   },
   "artists": [
      {
         "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
         "entityid": "19_xqonjx408hdv0e8upnvqg98an_60CQNohiJxVssiJysT2XOB",
         "followerscount": 2244,
         "genres": [
            "croatian pop",
            "yugoslav rock"
         ],
         "id": "60CQNohiJxVssiJysT2XOB",
         "link": "https://open.spotify.com/artist/60CQNohiJxVssiJysT2XOB",
         "name": "Magazin",
         "popularity": 34,
         "resources": [
            {
               "aspectratio": {
                  "accuracy": 100,
                  "actual": "1:1",
                  "closest": "1:1"
               },
               "height": 640,
               "mimetype": "application/octet-stream",
               "type": 0,
               "url": "https://i.scdn.co/image/1cc518fa0f772b75a58b095000d02cc9f026841b",
               "width": 640
            },
            {
               "aspectratio": {
                  "accuracy": 100,
                  "actual": "1:1",
                  "closest": "1:1"
               },
               "height": 300,
               "mimetype": "application/octet-stream",
               "type": 0,
               "url": "https://i.scdn.co/image/21fe53f2d40ae957445fa7fb0df576a6e10ed282",
               "width": 300
            }
         ]
      }
   ],
   "availablemarkets": [
      "AD",
      "AR"
   ],
   "discnumber": 1,
   "duration": 222533,
   "entityid": "19_xqonjx408hdv0e8upnvqg98an_52wm7k3WvWXdtmy5ijqyrA",
   "explicit": false,
   "id": "52wm7k3WvWXdtmy5ijqyrA",
   "link": "https://open.spotify.com/track/52wm7k3WvWXdtmy5ijqyrA",
   "name": "Kad Bi Bio Blizu",
   "number": 15,
   "popularity": 6,
   "resources": [
      {
         "duration": 30000,
         "mimetype": "audio/mp3",
         "type": 2,
         "url": "https://p.scdn.co/mp3-preview/f5006b1c23b8a7d3c2bc7f63edc2e627c0d24277?cid=8f62e65c31d74c15b9c8129505694ee1"
      }
   ]
}

Internal Objects

Activity Level

Field
Data Type
Description
Example
minutes
number
name
string
"sedentary"

Address

Field
Data Type
Is Required
Example
accountentityid
string
baseid
string
city
string
true
country
string
true
createddate
number
district
string
true
entityid
string
line
string[]
true
period
true
postalcode
string
true
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
state
string
true
text
string
true
type
string
true
updateddate
number
use
string
true

Album

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an"
artists
Internal Object reference
[
   {
      "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
      "entityid": "19_xqonjx408hdv0e8upnvqg98an_0LyfQWJT6nXafLPZqxe9Of",
      "id": "0LyfQWJT6nXafLPZqxe9Of",
      "link": "https://open.spotify.com/artist/0LyfQWJT6nXafLPZqxe9Of",
      "name": "Various Artists"
   }
]
availablemarkets
string
[
   "AD",
   "AR"
]
copyrights
Internal Object reference
[
   {
      "text": "Croatia Records",
      "type": "C"
   },
   {
      "text": "Croatia Records",
      "type": "P"
   }
]
entityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an_4Tyb8HuDO4b47fuORGqdtq"
genres
[

]
id
string
"4Tyb8HuDO4b47fuORGqdtq"
label
string
"Croatia Records"
link
string
"https://open.spotify.com/album/4Tyb8HuDO4b47fuORGqdtq"
name
string
"40 Velikih Hitova (Opusti Se I Uživaj)"
popularity
number
21
releasedate
number
1498608000000
resources
Internal Object reference
[
   {
      "aspectratio": {
         "accuracy": 100,
         "actual": "1:1",
         "closest": "1:1"
      },
      "height": 640,
      "mimetype": "application/octet-stream",
      "type": 0,
      "url": "https://i.scdn.co/image/1be0cd93902f944a46f7b2c206ca9c52730d37bc",
      "width": 640
   },
   {
      "aspectratio": {
         "accuracy": 100,
         "actual": "1:1",
         "closest": "1:1"
      },
      "height": 300,
      "mimetype": "application/octet-stream",
      "type": 0,
      "url": "https://i.scdn.co/image/665b6803d9c89dc3e432e41cd1cfaf255b3af8d1",
      "width": 300
   }
]
tracks
Internal Object reference
[
   {
      "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
      "artists": [
         {
            "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
            "entityid": "19_xqonjx408hdv0e8upnvqg98an_4F0b9Cx0VIVVOLFgehonr6",
            "id": "4F0b9Cx0VIVVOLFgehonr6",
            "link": "https://open.spotify.com/artist/4F0b9Cx0VIVVOLFgehonr6",
            "name": "Halid Bešlić"
         }
      ],
      "availablemarkets": [

      ],
      "discnumber": 1,
      "duration": 193453,
      "entityid": "19_xqonjx408hdv0e8upnvqg98an_7rBTPxrnwpnZbnQoTqE3mg",
      "explicit": false,
      "id": "7rBTPxrnwpnZbnQoTqE3mg",
      "link": "https://open.spotify.com/track/7rBTPxrnwpnZbnQoTqE3mg",
      "name": "Mostovi tuge",
      "number": 1
   },
   {
      "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
      "artists": [
         {
            "accountentityid": "19_xqonjx408hdv0e8upnvqg98an",
            "entityid": "19_xqonjx408hdv0e8upnvqg98an_4F0b9Cx0VIVVOLFgehonr6",
            "id": "4F0b9Cx0VIVVOLFgehonr6",
            "link": "https://open.spotify.com/artist/4F0b9Cx0VIVVOLFgehonr6",
            "name": "Halid Bešlić"
         }
      ],
      "availablemarkets": [

      ],
      "discnumber": 1,
      "duration": 219360,
      "entityid": "19_xqonjx408hdv0e8upnvqg98an_69d0OcADV4x128JfkMqeeb",
      "explicit": false,
      "id": "69d0OcADV4x128JfkMqeeb",
      "link": "https://open.spotify.com/track/69d0OcADV4x128JfkMqeeb",
      "name": "Daleko je sreca",
      "number": 2
   }
]
type
string
"compilation"

Annotation

Field
Data Type
Is Required
Example
accountentityid
string
authorreference
true
authorstring
string
true
baseid
string
createddate
number
entityid
string
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
text
string
true
"undefined"
time
number
true
updateddate
number

Artists

Field
Data Type
Description
Example
accountentityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an"
entityid
string
Internal index used by digi.me
"19_xqonjx408hdv0e8upnvqg98an_60CQNohiJxVssiJysT2XOB"
followerscount
number
2244
genres
string
[
   "croatian pop",
   "yugoslav rock"
]
id
string
"60CQNohiJxVssiJysT2XOB"
link
string
"https://open.spotify.com/artist/60CQNohiJxVssiJysT2XOB"
name
string
"Magazin"
popularity
number
34
resources
Internal Object reference
[
   {
      "aspectratio": {
         "accuracy": 100,
         "actual": "1:1",
         "closest": "1:1"
      },
      "height": 640,
      "mimetype": "application/octet-stream",
      "type": 0,
      "url": "https://i.scdn.co/image/1cc518fa0f772b75a58b095000d02cc9f026841b",
      "width": 640
   },
   {
      "aspectratio": {
         "accuracy": 100,
         "actual": "1:1",
         "closest": "1:1"
      },
      "height": 300,
      "mimetype": "application/octet-stream",
      "type": 0,
      "url": "https://i.scdn.co/image/21fe53f2d40ae957445fa7fb0df576a6e10ed282",
      "width": 300
   }
]

Asleep

Field
Data Type
Description
Example
count
number
minutes
number
398

Aspect Ratio

Field
Data Type
Description
Example
accuracy
number
100
actual
string
"1:1"
closest
string
"1:1"

Categories

Field
Data Type
Description
Example
codings
Internal Object reference
[
   {
      "code": "vital-signs",
      "display": "Vital Signs"
   }
]
text
string
"Vital Signs"

Category

Field
Data Type
Description
Example
codings
Internal Object reference
[
   {
      "system": "http://argonaut.hl7.org",
      "code": "problem",
      "display": "Problem"
   }
]
name
string
"Problem"

Codeable Concept

Field
Data Type
Is Required
Example
accountentityid
string
baseid
string
coding
true
[
   {
      "code": "40707",
      "display": "eye exam",
      "system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.696580"
   }
]
createddate
number
entityid
string
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
text
string
true
"eye exam"
updateddate
number

Coding

Field
Data Type
Is Required
Example
accountentityid
string
baseid
string
code
string
true
"40707"
createddate
number
display
string
true
"eye exam"
entityid
string
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
system
string
true
"urn:oid:1.2.840.114350.1.13.0.1.7.2.696580"
updateddate
number
userselected
boolean
true
version
string
true

Codings

Field
Data Type
Description
Example
code
string
"tempreture"
display
string
"Lkamshiti"
system
string
"6"

Communication

Field
Data Type
Is Required
Example
accountentityid
string
baseid
string
createddate
number
entityid
string
language
true
preferred
boolean
true
referenceentityid
string
referenceentitytype
number
socialnetworkuserentityid
string
updateddate
number

Component

Field
Data Type
Is Required
Example
accountentityid
string
baseid
string
code
true