PIpipedrive
Goals

Get result of a goal

Changed on

Gets the progress of a goal for the specified period.

get/goals/{id}/results

Request

  • Base URL
    https://api.pipedrive.com/v1
  • Auth
    • API key in header x-api-token
    • or OAuth 2
      Authorization code: https://oauth.pipedrive.com/oauth/authorize
      Token URL: https://oauth.pipedrive.com/oauth/token scopes: goals:read, goals:full

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.

timezonestring

The IANA timezone to use when evaluating period boundaries (e.g. America/Sao_Paulo). The start and end of the period are interpreted in this timezone. If omitted, defaults to the timezone of the user making the request.

Response

Successful response containing payload in the data.goal object

successboolean

If the request was successful or not

Changes

  • 2c92ce301ed8Revision changes
    • info

      added the new optional query request parameter timezone

  • 6749e4ab1790Revision changes
    • breaking

      the //// response's property type changed from string to array for status

    • info

      added the optional property //// to the response with the status