Skip to content
Digi.me Developers Portal Home
Skip to content

Achievement (object)

Represents a user gaining an achievement

Object details

  • accountentityid  

    Internal index used by digi.me

    • Data Type   string

    • Example   "18_7GYFKW"

  • baseid  

    Internal index used by digi.me

    • Data Type   string

  • category  

    • Data Type   string

    • Example   "Lifetime Distance"

  • createddate  

    Date expressed as a unix timestamp

    • Data Type   number

    • Example   1568851200000

  • description  

    • Data Type   string

    • Example   "26 lifetime miles"

  • earnedmessage  

    • Data Type   string

    • Example   "Whoa! Youve earned the Marathon badge!"

  • entityid  

    Internal index used by digi.me

    • Data Type   string

    • Example   "18_7GYFKW_22B8MB"

  • gradientendcolor  

    • Data Type   string

    • Example   "38D7FF"

  • gradientstartcolor  

    • Data Type   string

    • Example   "2DB4D7"

  • id  

    • Data Type   string

    • Example   "22B8MB"

  • marketingdescription  

    • Data Type   string

    • Example   "By reaching 26 lifetime miles, youve earned the Marathon badge!"

  • mobiledescription  

    • Data Type   string

    • Example   "Youve walked your way to your first lifetime miles badge. If this is just the starting line, we cant wait to see where you finish!"

  • name  

    • Data Type   string

    • Example   "Marathon (26 lifetime miles)"

  • referenceentityid  

    Internal index used by digi.me

    • Data Type   string

  • referenceentitytype  

    Internal index used by digi.me

    • Data Type   number

  • resources  

    Internal object reference

    • Data Type   Resource[]

    • Example  

      [
          {
              "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_lifetime_miles26_2.png",
              "width": 100
          }
      ]
      
  • sharetext  

    • Data Type   string

    • Example   "I covered 26 miles with my #Fitbit and earned the Marathon badge."

  • shortdescription  

    • Data Type   string

    • Example   "26 miles"

  • shortname  

    • Data Type   string

    • Example   "Marathon"

  • socialnetworkuserentityid  

    Internal index used by digi.me

    • Data Type   string

  • timesachieved  

    • Data Type   number

    • Example   1

  • type  

    • Data Type   string

    • Example   "LIFETIME_DISTANCE"

  • updateddate  

    Date expressed as a unix timestamp

    • Data Type   number

    • Example   1564358400000

  • value  

    • Data Type   number

    • Example   26