Get result of a goal
GET {{baseUrl}}/goals/:id/results?period.start=<date>&period.end=<date>
Gets the progress of a goal for the specified period.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
period.start | string | (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.end | string | (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. | |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"statusCode":20000,"statusText":"OK","service":"statistics-goals-api","data":{"goal":{"id":"5665cef556ddff22606fc8f6c0004807","owner_id":987654,"title":"Some example goal","type":{"name":"Deals started","params":{"pipeline_id":[5,2],"activity_type_id":[9]}},"assignee":{"type":"company","id":123456},"interval":"weekly","duration":{"start":"2019-11-01","end":"2020-10-30"},"expected_outcome":{"target":100,"tracking_metric":"quantity"},"is_active":false,"report_ids":["f37bd66a2ab64d28ff6a9b6d2289813a"]},"progress":3}}