GET /rest/v2.0/companies/{company_id}/projects/{project_id}/advanced_forecastings/rows

Get Advanced forecasting rows. Each page will have a maximum of 100 items.

Servers

Path parameters

Name Type Required Description
project_id String Yes

Unique identifier for the project.

company_id String Yes

Unique identifier for the company.

Request headers

Name Type Required Description
Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Query parameters

Name Type Required Description
budget_view_id String No

Unique identifier for the Budget View (also known as Budget Template). Required to return spread amount for other curves besides manual.

page Integer No

Page

filters[] Array No

Array structure to filter the result of the advanced forecasting endpoint Supported filter objects (with and without budget_view_id):

  • WBS segment item filter Structure:

    • id: <segment_id>
    • tier: <segment_tier>
    • type: 'segment'
    • values:

    Example: {"id": "23", tier: <segment_tier>, "type": "segment", "values": [2]}

    URL example: https://app.procore.com/rest/v2.0/companies/<company_id>/projects/<project_id>/advanced_forecastings/rows?filters[][id]=23&filters[][tier]=1&filters[][type]=segment&filters[][values][]=2&page=1&per_page=100&budget_view_id=2

Supported filters only if budget_view_id is provided:

  • Actuals by date Structure:

    • id: 'date_range_for_actuals'
    • code: 'date_range_for_actuals'
    • type: 'date_range_for_actuals'
    • values: [<start_date>(YYYY-MM-DD), <end_date>(YYYY-MM-DD), <include_actuals_without_dates (boolean)>].

    Example: {"id": "date_range_for_actuals", "code": "date_range_for_actuals", "type": "date_range_for_actuals", "values": ["2021-01-01", "2021-01-31", false]}

    URL Example: https://app.procore.com/rest/v2.0/companies/<company_id>/projects/<project_id>/advanced_forecastings/rows?filters[][code]=date_range_for_actuals&filters[][id]=date_range_for_actuals&filters[][type]=date_range_for_actuals&filters[][values][]=2021-01-01&filters[][values][]=2021-01-31&filters[][values][]=false&page=1&per_page=100&budget_view_id=2

per_page Integer No

Elements per page

Default value: 10

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.