The Investment profile API provides ticket metric data as well as a list of tickets found in Ticket log.
In this article
Permissions
Users calling the Investment profile API must have the Metrics API permission as well as a valid and unique API key. To enable API permissions for users, you must have the Manage User Permissions permission. Learn more about administrative permissions and API keys in Flow.
Important: If a user does not have both the Metrics API permission and an API key, they can't use the Investment profile API. If your user can't call the Investment profile API, verify they have both the permission and a valid API key.
To enable the Metrics API permission for a user, make sure the permission is added to at least one role they are assigned to.
Calling the API
Call the API endpoint over standard HTTPS. Use any tool or programming language that can add the authorization: Bearer <API Key> header.
The base URL for the API is https://flow-api.pluralsight.com/ticket-delivery/investment-profile.
Supported parameters
The Investment profile API requires a date_range when making a request.
The date range must be in the form: ["YYYY-MM-DDTHH:mm:ss+TZ_offset","YYYY-MM-DDTHH:mm:ss+TZ_offset"].
Learn more about additional parameters for this API in the Swagger documentation (opens in new tab).
Tip: You can also use the Swagger documentation to receive responses from the API. To do this:
- Click Authorize.
- Put
Bearer <Flow API key>in the value field. Click Authorize. You must include Bearer in the field. - Click Try it out. Input parameters as desired.
- Click Execute.
Endpoints
This API contains three endpoints. The data from these endpoints match what is available in Investment profile.
-
/investment-profile/aggregate/: Lists values for tickets, story points, and dev weeks broken down by investment layers. -
/investment-profile/epic/: Lists values for tickets, story points, and dev weeks by epic, broken down by investment layers. -
/investment-profile/team/: Lists values for tickets, story points, and dev weeks by team, broken down by investment layers.
Note: Dev weeks is referred to as FTEs in the API response.
/investment-profile/aggregate/
| Parameter | Description | Example |
|---|---|---|
| date_range | Specifies the date range to look for tickets in. For tickets and story points, all tickets moved to a Done state during this date range are included. For dev weeks, tickets with an activity signal during the date range are included. | date_range=["2024-06-24T09:00:00-6:00","2024-07-24T09:00:00-6:00"] |
| current_assignee | Specifies whether to exclude historical assignees from the calculations and only reference current assignees. Defaults to false. | current_assignee=false |
| include_nested_team | Determines whether data associated with nested teams and team members of the selected team are included in the response. Defaults to false. | include_nested_teams=true |
| status_states | Determines whether to include Done or Active tickets in the response. Defaults to Done. | status_states=Done |
| team_id | Flow-created team ID. The API response only includes tickets where the apex user is a member of the team and was an assignee on the ticket while it was in an active state. | team_id=123456 |
| team_id__in | Comma-separated list of team IDs. | team_id__in=123456,234567 |
| apex_user_id | Flow-created user ID. The API response only includes tickets where the apex user was an assignee on the ticket or had an activity signal associated with them while it was in an active state. | apex_user_id=1234567 |
| apex_user_id__in | Comma-separated list of apex user IDs. | apex_user_id__in=1234567,2345678 |
| limit | Number of records returned per query. The default value is 30. | limit=25 |
| offset | Number of records to skip before returning a record. Defaults to 0. | offset=0 |
/investment-profile/epic/
| Parameter | Description | Example |
|---|---|---|
| date_range | Specifies the date range to look for tickets in. For tickets and story points, all tickets moved to a Done state during this date range are included. For dev weeks, tickets with an activity signal during the date range are included. | date_range=["2024-06-24T09:00:00-6:00","2024-07-24T09:00:00-6:00"] |
| current_assignee | Specifies whether to exclude historical assignees from the calculations and only reference current assignees. Defaults to false. | current_assignee=false |
| include_nested_team | Determines whether data associated with nested teams and team members of the selected team are included in the response. Defaults to false. | include_nested_teams=true |
| status_states | Determines whether to include Done or Active tickets in the response. Defaults to Done. | status_states=Done |
| team_id | Flow-created team ID. The API response only includes tickets where the apex user is a member of the team and was an assignee on the ticket while it was in an active state. | team_id=123456 |
| team_id__in | Comma-separated list of team IDs. | team_id__in=123456,234567 |
| apex_user_id | Flow-created user ID. The API response only includes tickets where the apex user was an assignee on the ticket or had an activity signal associated with them while it was in an active state. | apex_user_id=1234567 |
| apex_user_id__in | Comma-separated list of apex user IDs. | apex_user_id__in=1234567,2345678 |
| limit | Number of records returned per query. The default value is 30. | limit=25 |
| offset | Number of records to skip before returning a record. Defaults to 0. | offset=0 |
/investment-profile/team/
| Parameter | Description | Example |
|---|---|---|
| date_range | Specifies the date range to look for tickets in. For tickets and story points, all tickets moved to a Done state during this date range are included. For dev weeks, tickets with an activity signal during the date range are included. | date_range=["2024-06-24T09:00:00-6:00","2024-07-24T09:00:00-6:00"] |
| current_assignee | Specifies whether to exclude historical assignees from the calculations and only reference current assignees. Defaults to false. | current_assignee=false |
| include_nested_team | Determines whether data associated with nested teams and team members of the selected team are included in the response. Defaults to false. | include_nested_teams=true |
| status_states | Determines whether to include Done or Active tickets in the response. Defaults to Done. | status_states=Done |
| team_id | Flow-created team ID. The API response only includes tickets where the apex user is a member of the team and was an assignee on the ticket while it was in an active state. | team_id=123456 |
| team_id__in | Comma-separated list of team IDs. | team_id__in=123456,234567 |
| apex_user_id | Flow-created user ID. The API response only includes tickets where the apex user was an assignee on the ticket or had an activity signal associated with them while it was in an active state. | apex_user_id=1234567 |
| apex_user_id__in | Comma-separated list of apex user IDs. | apex_user_id__in=1234567,2345678 |
| limit | Number of records returned per query. The default value is 30. | limit=25 |
| offset | Number of records to skip before returning a record. Defaults to 0. | offset=0 |