Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19).

## [Unreleased]
### Added
- Added optional `timezone` parameter to `GET /v1/goals/{id}/results`. Accepts an IANA timezone name (e.g. `America/Sao_Paulo`). Defaults to the timezone of the requesting user. Period boundaries are now evaluated in the specified timezone instead of UTC, making results consistent with the Insights UI.

## [36.1.2] - 2026-11-06
### Fixed
Expand Down
32 changes: 23 additions & 9 deletions src/versions/v1/api/goals-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,11 @@ export const GoalsApiAxiosParamCreator = function (configuration?: Configuration
* @param {string} id The ID of the goal that the results are looked for
* @param {string} period_start 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.
* @param {string} period_end 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.
* @param {string} [timezone] 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.

* @throws {RequiredError}
*/
getGoalResult: async (id: string, period_start: string, period_end: string, ): Promise<RequestArgs> => {
getGoalResult: async (id: string, period_start: string, period_end: string, timezone?: string, ): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('getGoalResult', 'id', id)
// verify required parameter 'period_start' is not null or undefined
Expand Down Expand Up @@ -169,6 +170,10 @@ export const GoalsApiAxiosParamCreator = function (configuration?: Configuration
period_end;
}

if (timezone !== undefined) {
localVarQueryParameter['timezone'] = timezone;
}



setSearchParams(localVarUrlObj, localVarQueryParameter);
Expand Down Expand Up @@ -392,11 +397,12 @@ export const GoalsApiFp = function(configuration?: Configuration) {
* @param {string} id The ID of the goal that the results are looked for
* @param {string} period_start The start date of the period for which to find the goal\&#39;s progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date.
* @param {string} period_end The end date of the period for which to find the goal\&#39;s progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date.
* @param {string} [timezone] The IANA timezone to use when evaluating period boundaries (e.g. &#x60;America/Sao_Paulo&#x60;). The start and end of the period are interpreted in this timezone. If omitted, defaults to the timezone of the user making the request.

* @throws {RequiredError}
*/
async getGoalResult(id: string, period_start: string, period_end: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetGoalResultResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getGoalResult(id, period_start, period_end, );
async getGoalResult(id: string, period_start: string, period_end: string, timezone?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetGoalResultResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getGoalResult(id, period_start, period_end, timezone, );
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
Expand All @@ -405,11 +411,12 @@ export const GoalsApiFp = function(configuration?: Configuration) {
* @param {string} id The ID of the goal that the results are looked for
* @param {string} period_start The start date of the period for which to find the goal\&#39;s progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date.
* @param {string} period_end The end date of the period for which to find the goal\&#39;s progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date.
* @param {string} [timezone] The IANA timezone to use when evaluating period boundaries (e.g. &#x60;America/Sao_Paulo&#x60;). The start and end of the period are interpreted in this timezone. If omitted, defaults to the timezone of the user making the request.

* @throws {RequiredError}
*/
async getGoalResultWithHttpInfo(id: string, period_start: string, period_end: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetGoalResultResponse>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getGoalResult(id, period_start, period_end, );
async getGoalResultWithHttpInfo(id: string, period_start: string, period_end: string, timezone?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetGoalResultResponse>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getGoalResult(id, period_start, period_end, timezone, );
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
},
/**
Expand Down Expand Up @@ -526,10 +533,10 @@ export const GoalsApiFactory = function (configuration?: Configuration, basePath
* @throws {RequiredError}
*/
getGoalResult(requestParameters: GoalsApiGetGoalResultRequest, ): Promise<GetGoalResultResponse> {
return localVarFp.getGoalResult(requestParameters.id, requestParameters.period_start, requestParameters.period_end, ).then((request) => request(axios, basePath));
return localVarFp.getGoalResult(requestParameters.id, requestParameters.period_start, requestParameters.period_end, requestParameters.timezone, ).then((request) => request(axios, basePath));
},
getGoalResultWithHttpInfo(requestParameters: GoalsApiGetGoalResultRequest, ): Promise<ApiResponse<GetGoalResultResponse>> {
return localVarFp.getGoalResultWithHttpInfo(requestParameters.id, requestParameters.period_start, requestParameters.period_end, ).then((request) => request(axios, basePath));
return localVarFp.getGoalResultWithHttpInfo(requestParameters.id, requestParameters.period_start, requestParameters.period_end, requestParameters.timezone, ).then((request) => request(axios, basePath));
},
/**
* 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.
Expand Down Expand Up @@ -614,6 +621,13 @@ export interface GoalsApiGetGoalResultRequest {
* @memberof GoalsApiGetGoalResult
*/
readonly period_end: string

/**
* The IANA timezone to use when evaluating period boundaries (e.g. &#x60;America/Sao_Paulo&#x60;). The start and end of the period are interpreted in this timezone. If omitted, defaults to the timezone of the user making the request.
* @type {string}
* @memberof GoalsApiGetGoalResult
*/
readonly timezone?: string
}

/**
Expand Down Expand Up @@ -799,7 +813,7 @@ export class GoalsApi extends BaseAPI {
* @memberof GoalsApi
*/
public getGoalResult(requestParameters: GoalsApiGetGoalResultRequest, ) {
return GoalsApiFp(this.configuration).getGoalResult(requestParameters.id, requestParameters.period_start, requestParameters.period_end, ).then((request) => request(this.axios, this.basePath));
return GoalsApiFp(this.configuration).getGoalResult(requestParameters.id, requestParameters.period_start, requestParameters.period_end, requestParameters.timezone, ).then((request) => request(this.axios, this.basePath));
}

/**
Expand All @@ -811,7 +825,7 @@ export class GoalsApi extends BaseAPI {
* @memberof GoalsApi
*/
public getGoalResultWithHttpInfo(requestParameters: GoalsApiGetGoalResultRequest, ) {
return GoalsApiFp(this.configuration).getGoalResultWithHttpInfo(requestParameters.id, requestParameters.period_start, requestParameters.period_end, ).then((request) => request(this.axios, this.basePath));
return GoalsApiFp(this.configuration).getGoalResultWithHttpInfo(requestParameters.id, requestParameters.period_start, requestParameters.period_end, requestParameters.timezone, ).then((request) => request(this.axios, this.basePath));
}

/**
Expand Down
Loading