Boostramp - SEO co-pilot

API - Backlinks

API gateway

https://app.boostramp.com/api/backlink.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. getBacklinks

get project backlinks

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getBacklinks

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): , "first-seen", "last-seen", "domain-rank", default "rank"
  • (GET) order (optional): ASC or DESC, default DESC
  • (GET) limit (int, optional): lines in the report, default 50
  • (GET) page_id (int, optional): get backlinks for specific page


2. getLostBacklinks

get lost backlinks for the last 90 days

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getLostBacklinks

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. getMonitoringBacklinks

edit project monitoring backlinks 

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getMonitoringBacklinks

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): default "date-added"
  • (GET) order (optional): ASC or DESC, default DESC
  • (GET) limit (int, optional): lines in the report, default 50


4. getMonitoringBacklinkHistory

Backlink monitoring history

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getMonitoringBacklinkHistory

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) backlink_id (int, required): Backlink ID


5. removeMonitoringBacklink

Stop backlink monitoring

Endpoint 

https://app.boostramp.com/api/backlink.php?func=removeMonitoringBacklink

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) backlink_id (int, required): Backlink ID


6. addMonitoringBacklinks

Start backlink monitoring

Endpoint 

https://app.boostramp.com/api/backlink.php?func=addMonitoringBacklinks

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) backlink_id (int, required): Backlink ID


7. getTotalBacklinks

Get the total backlinks

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getTotalBacklinks

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) page_id (int, optional): get total backlinks for specific page


8. getBacklinksAnchors

Get statistics on backlinks anchors

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getBacklinksAnchors

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) page_id (int, optional): get anchors for specific page


9. getBacklinksNewLost

Get statistics on new and lost backlinks

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getBacklinksNewLost

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)


10. getBacklinksOvertime

Get the number of backlinks and referring domains over time

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getBacklinksOvertime

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) page_id (int, optional): get the number of backlinks for a specific page


11. getTotalMonitoringBacklinksByUser

count all monitoring backlinks in the account (total monitoring backlinks in all projects)

Endpoint 

https://app.boostramp.com/api/backlink.php?func=getTotalMonitoringBacklinksByUser

Parameters

  • (GET) token (int, required): Your API session token