Report Generation (Beta)

Running a report generates a PDF for each associated portfolio for a given time period. Use the Report Generation API to run a report from outside the Addepar web application.

After you run a report, you can access a portfolio's report PDF from a its Generated PDFs tab in Addepar, or via the Generated Reports API.

Note that you can't get report ID via API yet. You can find a report's ID in its Addepar web application URL.

📘
Beta Feature
The base route /v1/report_generation_job and all corresponding endpoints described herein are in the Addepar Beta Program. All beta features described herein are provided “as is'” and “as available” with no warranty or guarantee of functionality and may be modified or removed at any time by Addepar.
Please send feedback or questions to your Addepar contact.


Base route	/v1/report_generation_job
Endpoints	POST
Produces	JSON
Pagination	Yes
OAuth scopes	`REPORTS_WRITE`
Application permissions required	"Access to all tools and portfolios."

Resource Overview

You can request a report generation job by providing the below resource object attributes. All attributes are required.

Attribute	Description	Example
`report_id`	The ID of the report that you want to run. Integer. You can find a report's ID in its Addepar web application URL.	`4`
`portfolios`	The list of entities or groups that you want to run reports for. JSON object. For each portfolio, provide both: - `portfolio_type`, either "entity" or "group. String. - `portfolio_id`, the portfolio's Entity ID or Group ID. String.	`[ {"portfolio_type": "entity", "portfolio_id": "22"}, {"portfolio_type": "group", "portfolio_id": "3"} ]`
`start_date`	The report's start date. String, formatted as YYYY-MM-DD. Can't be later than `end_date`.	`"2023-07-01"`
`end_date`	The report's end date. String, formatted as YYYY-MM-DD. Can't be earlier than `start_date`.	`"2023-08-01"`

Run a Report

Requests to generate a report PDF for each associated and specified portfolio.

POST /v1/report_generation_job

Example:

{
    "data": {
        "type": "report_generation_job",
        "attributes": {
            "report_id": "5",
            "portfolios": [
                {
                "portfolio_type": "entity",
                "portfolio_id": "22"
                }
            ],
            "start_date": "2023-07-01",
            "end_date": "2023-08-01"
            }
    }
}

{
    "data": {
        "id": "b37e4e27-14b8-486c-b2c9-d0d6c9991fcb",
        "type": "report_generation_job_id",
        "links": {
            "self": "/v1/report_generation_job_id/b37e4e27-14b8-486c-b2c9-d0d6c9991fcb"
        }
    },
    "included": []
}

Response Codes

200 OK: Success
400 Bad Request: Add a perspective type and ID.
400 Bad Request: The following perspectives don't exist, have incorrect perspective types, or you don't have permission to access them:
400 Bad Request: The following perspectives aren't enabled for the report:
400 Bad Request: Change the start date to be on or before the end date.
400 Bad Request: Add perspective types for the following IDs:
400 Bad Request: One or more perspectives are missing IDs.
400 Bad Request: Add a report ID.
400 Bad Request: The types for the following perspectives are unsupported: . Entity or group are the only supported types.
400 Not Found: Report [Report ID] was deleted, or you don’t have permission to access it.