API - Growth opportunities
API gateway
https://app.boostramp.com/api/opportunity.php?token=%token%&func=%function%
Required GET fields
token - Your API session token. Learn how to log in and obtain your session token
func - The API function you wish to call
For guidance on how to use the Boostramp API, refer to our API usage example article
Endpoints
1. getOpportunities
get project opportunities
Endpoint
https://app.boostramp.com/api/opportunity.php?func=getOpportunities
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (GET) sort (string, optional): , "favorites", "date_added", default "date_added"
- (GET) order (optional): ASC or DESC, default DESC
- (GET) limit (int, optional): lines in the report, default 50
- (GET) start (int, optional): line to start from, default 0
2. getTotalOpportunities
Get total project opportunities
Endpoint
https://app.boostramp.com/api/opportunity.php?func=getTotalOpportunities
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
3. removeOpportunity
Delete opportunity
Endpoint
https://app.boostramp.com/api/opportunity.php?func=removeOpportunity
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (GET) opportunity_id (int, required): Opportunity ID
4. removeAllOpportunities
Delete all opportunities
Endpoint
https://app.boostramp.com/api/opportunity.php?func=removeAllOpportunities
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
5. addToFavorites
Add the opportunity to Favorites
Endpoint
https://app.boostramp.com/api/opportunity.php?func=addToFavorites
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (GET) opportunity_id (int, required): Opportunity ID
6. removeFromFavorites
Delete the opportunity from Favorites
Endpoint
https://app.boostramp.com/api/opportunity.php?func=removeFromFavorites
Parameters
- (GET) token (int, required): Your API session token.
- (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
- (GET) opportunity_id (int, required): Opportunity ID
