v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Exercise Logs

get all

Returns a list of exercise logs you've previously created. The exercise logs will be returned in descending order of when they were created, unless you specify otherwise.

For custom components:

RaiselyComponents.api.all('exercise-logs').get(params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

get/exercise-logs

Query parameters

privateboolean

Returns the full record when authenticated

qstring

Search query to find records matching

limitnumber

The number of records to limit per page

offsetnumber

The pagination offset (in number of records)

sortstring

The record attribute to filter on (use in conjunction with order)

order'asc' | 'desc'

The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending

profilestring
Example:aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa

Filter exercise logs by only returning logs matching the specified profile (uuid or path)

userstring
Example:aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa

Filter exercise logs by only returning logs matching the specified person uuid

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Response

The resulting collection of Exercise Log records

Example response

{
  "data": [
    {
      "activity": "RUNNING",
      "activityId": 12345,
      "data": {},
      "date": "2020-12-03T06:52:46.330Z",
      "distance": 12345,
      "measure": 12345,
      "profileUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "rawDistance": 12345,
      "time": 12345,
      "user": {
        "accessToken": "aaabbbccc",
        "address1": "31 Sunset Boulevard",
        "address2": "Unit 31b",
        "adminSettings": {
          "v4BetaOptin": true,
          "starredCampaigns": [
            "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
            "ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj"
          ]
        },
        "country": "AU",
        "createdAt": "2020-12-03T06:52:46.330Z",
        "email": "harveymilk@example.com",
        "facebookId": "fb_someurl",
        "firstName": "Leila",
        "fullName": "Leila Norma de Lima",
        "internal": {},
        "isAdmin": true,
        "isSamlLogin": true,
        "lastName": "de Lima",
        "permission": "PARTICIPANT",
        "phoneNumber": "+1 123-456-7890",
        "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
        "postcode": "AAA BBBB",
        "preferredName": "Norma",
        "private": {
          "fieldA": "one",
          "fieldB": "yes"
        },
        "public": {
          "fieldA": "one",
          "fieldB": "yes"
        },
        "state": "Victoria",
        "status": "ACTIVE",
        "suburb": "Melbourne",
        "unsubscribedAt": "2020-12-03T06:52:46.330Z",
        "updatedAt": "2020-12-03T06:52:46.330Z",
        "username": "harveymilk@example.com",
        "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      },
      "userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    }
  ],
  "pagination": {
    "total": 10,
    "pages": 2,
    "offset": 5,
    "limit": 5
  }
}