Back to Pipedrive OauthGet result of a goal
Gets the progress of a goal for the specified period.
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
description: The ID of the goal that the results are looked for
period.start:
type: string
format: date
description: >
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:
type: string
format: date
description: >
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.
required:
- id
- period.start
- period.end
Output
title: getGoalResultResponse200
type: object
properties:
success:
type: boolean
description: If the request was successful or not
data:
type: object
properties:
progress:
type: integer
description: The numeric progress of the goal
goal:
type: object
properties:
id:
type: string
description: The ID of the goal
owner_id:
type: integer
description: The ID of the creator of the goal
title:
type: string
description: The title of the goal
type:
type: object
description: The type of the goal
properties:
name:
type: string
description: The name of the goal type
params:
type: object
description: The parameters that accompany the goal type
properties:
pipeline_id:
type: array
description: The IDs of pipelines of the goal
items:
type: integer
activity_type_id:
type: array
description: The IDs of activity types of the goal
items:
type: integer
assignee:
type: object
description: Who the goal is assigned to
properties:
id:
type: integer
description: The ID of the goal assignee
type:
type: string
description: The type of the assignee
interval:
type: string
description: The interval of the goal
duration:
type: object
description: The duration of the goal
properties:
start:
type: string
description: The start date of the goal
end:
type: string
description: The end date of the goal
expected_outcome:
type: object
description: The expected outcome of the goal
properties:
target:
type: integer
description: The numeric target of the goal
tracking_metric:
type: string
description: The tracking metric of the goal
is_active:
type: boolean
description: Whether the goal is currently active or not
report_ids:
type: array
description: The IDs of the reports that belong to the goal
items:
type: string