Find goals
GET {{baseUrl}}/goals/find?type.name=<string>&title=<string>&is_active=true&assignee.id=<integer>&assignee.type=<string>&expected_outcome.target=<number>&expected_outcome.tracking_metric=<string>&expected_outcome.currency_id=<integer>&type.params.pipeline_id=<integer>&type.params.pipeline_id=<integer>&type.params.stage_id=<integer>&type.params.activity_type_id=<integer>&type.params.activity_type_id=<integer>&period.start=<date>&period.end=<date>
Returns data about goals based on criteria. For searching, append {searchField}={searchValue} to the URL, where searchField can be any one of the lowest-level fields in dot-notation (e.g. type.params.pipeline_id; title). searchValue should be the value you are looking for on that field. Additionally, is_active=<true|false> can be provided to search for only active/inactive goals. When providing period.start, period.end must also be provided and vice versa.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
type.name | string | The type of the goal. If provided, everyone's goals will be returned. | |
title | string | The title of the goal | |
is_active | boolean | Whether the goal is active or not | |
assignee.id | string | The ID of the user who's goal to fetch. When omitted, only your goals will be returned. | |
assignee.type | string | The type of the goal's assignee. If provided, everyone's goals will be returned. | |
expected_outcome.target | string | The numeric value of the outcome. If provided, everyone's goals will be returned. | |
expected_outcome.tracking_metric | string | The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned. | |
expected_outcome.currency_id | string | The numeric ID of the goal's currency. Only applicable to goals with expected_outcome.tracking_metric with value sum. If provided, everyone's goals will be returned. | |
type.params.pipeline_id | string | An array of pipeline IDs or null for all pipelines. If provided, everyone's goals will be returned. | |
type.params.pipeline_id | string | An array of pipeline IDs or null for all pipelines. If provided, everyone's goals will be returned. | |
type.params.stage_id | string | The ID of the stage. Applicable to only deals_progressed type of goals. If provided, everyone's goals will be returned. | |
type.params.activity_type_id | string | An array of IDs or null for all activity types. Only applicable for activities_completed and/or activities_added types of goals. If provided, everyone's goals will be returned. | |
type.params.activity_type_id | string | An array of IDs or null for all activity types. Only applicable for activities_completed and/or activities_added types of goals. If provided, everyone's goals will be returned. | |
period.start | string | The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When period.start is provided, period.end must be provided too. | |
period.end | string | The end date of the period for which to find goals. Date in format of YYYY-MM-DD. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"statusCode":20000,"statusText":"OK","service":"statistics-goals-api","data":{"goals":[{"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"]}]}}