Get analytics

GET 
https://api.apparyllis.com/v1/user/analytics

Get analytics of authenticated user

Request

Query Parameters

startTime objectrequired

Start time in Unix timestamp format (millisecond accuracy)

endTime objectrequired

End time in Unix timestamp format (millisecond accuracy)

Responses

200

OK

application/json

Schema

Schema

timings object
Groups of member and/or custom front ids based on timings when they fronted
morningFrontersstring[]
dayFrontersstring[]
eveningFrontersstring[]
nightFrontersstring[]
values object
Values for the timeframe
sums object[]
Array [
idstring
The Id of the member
valuelong
Total length they fronted
]
averages object[]
Array [
idstring
The Id of the member
valuelong
Average length they fronted
]
maxes object[]
Array [
idstring
The Id of the member
valuelong
Maximum length they fronted
]
mins object[]
Array [
idstring
The Id of the member
valuelong
Minimum length they fronted
]
nums object[]
Array [
idstring
When this reminder should trigger. 0 -> Member front change, 1 -> Custom front change, 2 -> Any front change
valuelong
Amount of times they fronted
]

Example (auto)

{
  "timings": {
    "morningFronters": [
      "string"
    ],
    "dayFronters": [
      "string"
    ],
    "eveningFronters": [
      "string"
    ],
    "nightFronters": [
      "string"
    ]
  },
  "values": {
    "sums": [
      {
        "id": "string"
      }
    ],
    "averages": [
      {
        "id": "string"
      }
    ],
    "maxes": [
      {
        "id": "string"
      }
    ],
    "mins": [
      {
        "id": "string"
      }
    ],
    "nums": [
      {
        "id": "string"
      }
    ]
  }
}

404

NOT FOUND

Authorization: Authorization

name: Authorizationtype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.apparyllis.com/v1/user/analytics");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.apparyllis.com

Auth

APITokenAuth

Parameters

startTime — queryrequired

endTime — queryrequired

ResponseClear

Click the Send API Request button above and see the response here!