Portfolios

Detect portfolio changes

Detect material signal changes for tracked areas between periods.

post/v1/portfolios/{id}/changes

Request

  • Base URL: https://api.onegoodarea.com
  • URL: https://api.onegoodarea.com/v1/portfolios/{id}/changes
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

baseline'previous' | 'first'
threshold_pctnumber
min_transactionsnumber
emitboolean
causestring[]

List only changes with these causes; webhooks fire for the listed changes only. Default every cause.

Response

Default Response

portfolio_idstring required
baseline'previous' | 'first' required
threshold_pctnumber required
min_transactionsnumber required
areas_checkednumber required
material_countnumber required
causesstring[] required
generated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.