API - Pages

API gateway

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

Get lost of website pages

Endpoint 

https://app.boostramp.com/api/page.php?func=getPages

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): "loading-time", "title", "page-size", "total-impressions", "total-clicks", "backlinks", "keywords", "top_impressions", "top_clicks", "top_backlinks", "top_keywords", default "title"
  • (GET) order (optional): ASC or DESC, default DESC
  • (GET) start (int, optional): line to start from, default 0
  • (GET) limit (int, optional): lines in the report, default 50


2. removePage

Delete page

Endpoint 

https://app.boostramp.com/api/page.php?func=removePage

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, required): Page ID


3. removeAllPages

Delete all website pages

Endpoint 

https://app.boostramp.com/api/page.php?func=removeAllPages

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)


4. getPageInfo

Get page info

Endpoint 

https://app.boostramp.com/api/page.php?func=getPageInfo

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, required): Page ID


5. addPages

Delete Group

Endpoint 

https://app.boostramp.com/api/page.php?func=addPages

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)
  • (POST) pages (string, required): List of new pages (URLs). One per line ("\n" separator)


6. getTotalPagesByUser

count all pages in the account (total pages in all projects)

Endpoint 

https://app.boostramp.com/api/page.php?func=getTotalPagesByUser

Parameters

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


7. getLastCrawlingDate

Get last project pages crawling date

Endpoint 

https://app.boostramp.com/api/page.php?func=getLastCrawlingDate

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)