API Overview

Modified on Mon, 14 Nov 2022 at 10:42 AM

This article will give you an overview of how the API & Webhook works for the Agency Features that we offer along with details on how to use them properly.

First of all, make sure that your SEO Lead Gen.

API

The API will allow you to initiate tasks using simple requests.

Authentication

You will need your API token mentioned on the agency features page at the very

bottom: https://dash.brandoverflow.com/agency

Endpoint: https://api3.brandoverflow.com/leads_api

Add Lead

This method will add a lead to the system that you can then view/process via the dashboard.

Endpoint	https://api3.brandoverflow.com/leads_api
Method	POST

Request Body

{
    "token" : "your_api_token",
    "url" : "https://your_url.com",
    "name" : "Full Name",
    "email" : "Email",
}

Add Lead + Process Audit Immediately.

This method will add a lead to the system and add it to the processing queue immediately.

Endpoint	https://api3.brandoverflow.com/leads_api
Method	POST

Request Body

{
    "token" : "your_api_token",
    "url" : "https://your_url.com",
    "name" : "Full Name",
    "email" : "Email",
    "process_immediately" : true,
    "max_pages": 10
}

Reference

Key	Required	Description
token	Yes	Your api token as per your account settings
URL	Yes	The url of the website that is to be audited
name	Yes	Name of the lead
email	Yes	Email of the lead
process_immediately	Optional	Defaults to false, if set to true, it will add the audit task to the processing queue immediately.
max_pages	Optional	Number of pages to audit for this task.

Responses

If no error and everything went smoothly.

{
   "success" : true
}

If URL is invalid or missing

{
   "success" : false,
   "message" : "URL is invalid"
}

If the name is invalid or missing

{
   "success" : false,
   "message" : "Name is invalid"
}

If the email is invalid or missing

{
   "success" : false,
   "message" : "Email is invalid"
}

If the account doesn't have any limits left to process this request

{
   "success" : false,
   "message" : "Not enough Audit credits left."
}