v1

latestOpenAPI 3.0.12026-08-0621301.7 MB
Goals

Get result of a goal

Gets the progress of a goal for the specified period.

get/goals/{id}/results

Path parameters

idstring required

The ID of the goal that the results are looked for

Query parameters

period.startstring date required

The start date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date.

period.endstring date required

The end date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date.

Response

Successful response containing payload in the data.goal object

successboolean

If the request was successful or not