Introduction

Welcome to the BuzzBoard Ignite API v4.0 documentation.

The BuzzBoard Ignite API is an easy way to tap into BuzzBoard and use its features and functionalities to create your own BuzzBoard-powered applications for web, mobile and desktop.

We are always open to feedback, drop an email to support@buzzboard.com and let us know what you want to see from the BuzzBoard Ignite API.

PROPERTIES

The (meta) object is used across all APIs.

Field Type Description
count

Number

The number of items returned in this object.
last_generated

Number

Date and time the object was last generated in Unix timestamp format.
prospect_id

String

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/competition?prospect_id=1

status

Number

The HTTP status code of the operation.
message

String

A message applying to the last operation.

Users

The Users API allows you to retrieve information about users in your account. You can retrieve all the users at a time, or just a single user. This is read only access.

PROPERTIES

The following properties are for use with the Users API.

Field Type Description
id

Number

Unique identifier of the user.
username

String

Username of the user.
first_name

String

First name of the user.
last_name

String

Last name of the user.
phone

String

Phone number of the user.
mobile

String

Mobile number of the user.
email

String

Email of the user.
user_type

String

Type of the user. Possible values :

  • Project Manager
  • Sales Rep
  • Partner Manager
reporting_to

String

The name or identifier of the manager the user reports to.
profile_limit

Number

Profile limit of the user for the current month.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the user in Unix timestamp format.

ENDPOINTS

Users - List v4.0

Returns all users.

https://apis.buzzboard.com/v4.0/users

Returns all active users of partner.

curl -X GET "https://apis.buzzboard.com/v4.0/users"
-H "Authorization: Bearer $ACCESS_TOKEN" 
{
  "data": [
    {
      "id": 1,
      "username": "john@gmail.com",
      "first_name": "John",
      "last_name": "Lynna",
      "phone": "(441) 234-5687",
      "mobile": "9235687921",
      "email": "john@gmail.com",
      "user_type": "Project Manager",
      "reporting_to": null,
      "profile_limit": 250,
      "created_at": 1373023946,
      "updated_at": 1484632107
    },
    {
      "id": 2,
      "username": "danae@gmail.com",
      "first_name": "Denae",
      "last_name": "Cai",
      "phone": "(441) 234-568790",
      "mobile": "9234568330",
      "email": "danae@gmail.com",
      "user_type": "Sales Rep",
      "reporting_to": "John Lynna",
      "profile_limit": 250,
      "created_at": 1373024026,
      "updated_at": 1488449664
    }
  ],
  "meta": {
    "count": 2
  }
}

Users - Get Details v4.0

Returns a single user by the unique user Id.

https://apis.buzzboard.com/v4.0/users/{:id}

Parameters

Field Type Description
id Required

Number

Unique identifier of the user.

Retrieve a user with Id 1

curl -X GET "https://apis.buzzboard.com/v4.0/users/1"
-H "Authorization: Bearer $ACCESS_TOKEN" 
{
  "data": {
    "id": 1,
    "username": "john@gmail.com",
    "first_name": "John",
    "last_name": "Lynna",
    "phone": "(441) 234-5687",
    "mobile": null,
    "email": "john@gmail.com",
    "user_type": "Project Manager",
    "reporting_to": null,
    "profile_limit": 250,
    "created_at": 1373023946,
    "updated_at": 1484632107
  }
}

Prospect

The Prospect API allows you to add, update, change owners, regenerate and provide other details of a prospect.

PROPERTIES

The following properties are for use with the Prospect API.

Field Type Description
business_name

String

Name of the prospect.
website

String

Prospect's website. Required unless city and state fields are provided.
phone

String

Prospect's phone number.
contact_info

Object

Prospect's contact information. For more information about the contact_info object see Contact Info.
address

Object

Prospect's address information. For more information about the address object see Address.
primary_category_id

Number

Primary Category Id of the prospect.
secondary_category_id

Number

Secondary Category Id of the prospect.
score

Object

Score for the prospect. For more information about the score object see Score.
crm_sync New

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).
callback_url New

String

Callback URL to be invoked by the API method you're calling after it's done.
keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]
external_id

String

An Id you can use to link the BuzzBoard prospect to local records.
creator_id

Number

Unique identifier of the user who created the prospect.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the prospect in Unix timestamp format.

ENDPOINTS

Prospect - List v4.0

Returns all available prospects.

https://apis.buzzboard.com/v4.0/prospects

Parameters

Field Type Description
id

Number

Unique identifier of the user.

page_no

Number

Starting page number. By default page number starts from 1. If page_no is not specified, the returned records will start from first page.https://apis.buzzboard.com/v4.0/prospects?page_no=1

page_limit

Number

Number of records to be returned per page.https://apis.buzzboard.com/v4.0/prospects?page_limit=10

callback_url

String

Callback URL to be invoked by the API method you're calling after it's done.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).

query

JSON Object

Filter Parameters

  • Business name (The name of the business)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"business_name":"pizza"}
  • Score (This is the BuzzScore that is given to each prospect based on it's digital health)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"score":"10-20"}
  • Archive (The prospects which are marked as Archived by the user)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"archive": "1"}
  • Favorites (The prospects which are marked as Favorite by the user)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"favorites": "1"}
  • Monitored (The prospects which are marked by the user for monitoring)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"monitored": "1"}
  • Stage ids (Unique identifier of the stages)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"stage_ids":[712, 713]}
  • Propensity Ids (Unique identifier of the propensity)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"propensity_ids":[541,554,555]}
  • Sort by (The option to sort prospects by using different filters)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"sort_by":"buzzscore/added_date/business_name"}
  • Sort order (The order in which you want to sort the prospects)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"sort_order": "ASC/DESC"}
  • City (The city where the prospect is located)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"city":"Fredericksburg"}
  • State (The state in which the prospect is located)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"state":"VA"}
  • Country (The country where the prospect is located)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"country":"United Kingdom"}
  • Postal code (The postal code where the prospect's address falls into)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"zipcode":"22407"}
  • Line1 (It contains the primary address information)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"line1":"5717 Plank Rd"}
  • Date (Returns prospect list in the defined date range)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"date":"2017-04-17@^2017-04-18"}
latitude

Number

The latitude of prospect’s location.

longitude

Number

The longitude of prospect's location. 

curl -X GET "https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"business_name":"pizza"}
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "id": 1,
      "external_id": null,
      "business_name": "Carlos Pizza",
      "website": null,
      "phone": "(718) 894-7915",
      "address": {
        "line1": "7402 Metropolitan Ave",
        "city": "Middle Village",
        "zip": "11379",
        "state": "NY",
        "country": "United States"
      },
      "latitude": "40.7126348",
      "longitude": "-73.8781243",
      "score": {
        "value": 28,
        "color": "#0000E9"
      },
      "created_at": 1492675357,
      "creator_id": 1009,
      "updated_at": 1492675387
    },
    {
      "id": 2,
      "external_id": null,
      "business_name": "Pizza",
      "website": "http://www.pizza.com",
      "phone": "(111) 111-1111",
      "address": {
        "line1": "43930 Farmwell Hunt Plaza",
        "city": "Ashburn",
        "zip": "20147",
        "state": "VA",
        "country": "United States"
      },
      "latitude": "39.0236717",
      "longitude": "-77.4809538",
      "score": {
        "value": 55,
        "color": "#CEA900"
      },
      "created_at": 1491994487,
      "creator_id": 1009,
      "updated_at": 1491994513
    }
  ],
  "meta": {
    "count": 2
  }
}

Prospect - Create v4.0

Creates a new prospect.

https://apis.buzzboard.com/v4.0/prospects

Parameters

Field Type Description
business_name Required

String

Name of the prospect.

website

String

Prospect's website. Required unless city and state fields are provided.

phone

String

Prospect's phone number.

contact_info

Object

Prospect's contact information. For more information about the contact_info object see Contact Info.

address

Object

Prospect's address information. For more information about the address object see Address.

primary_category_id

Number

Primary category Id of the prospect.

secondary_category_id

Number

Secondary category Id of the prospect.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).

keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]

external_id

String

An identifier you can use to link the BuzzBoard prospect to local records.

owner_id

Number

The unique identifier of the user.(e.g.) https://apis.buzzboard.com/v4.0/prospects?owner_id=1009

Creates a new prospect 'Design Services Company' with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/prospects"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
  "data": {
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3010",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "keywords": [
      "My Business for Everything",
      "By Business",
      "Only Business"
    ],
    "external_id": "1237"
  }
}'
{
  "prospect_id": 1,
  "data": {
    "id": 1,
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3010",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "score": {
      "value": "P",
      "color": "#0000E9"
    },
    "external_id": "1237",
    "created_at": 1489750959,
    "updated_at": 1489750959
  }
}

Prospect - Create Many v4.0

Creates multiple prospects and a callback URL that will be invoked by the API method you are calling.

https://apis.buzzboard.com/v4.0/prospects/createmany

Parameters

Field Type Description
business_name Required

String

Name of the prospect.

website

String

Prospect's website. Required unless city and state fields are provided.

phone

String

Prospect's phone number.

contact_info

Object

Prospect's contact information. For more information about the contact_info object see Contact Info.

address

Object

Prospect's address information. For more information about the address object see Address.

primary_category_id

Number

Primary Category Id of the prospect.

secondary_category_id

Number

Secondary Category Id of the prospect.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force/Base CRM).

keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]

external_id

String

An Id you can use to link BuzzBoard prospect to local records.

callback_url

String

Callback URL to be invoked by the API method you're calling after it's done.

owner_id

Number

The unique identifier of the user.(e.g.) https://apis.buzzboard.com/v4.0/prospects/createmany?owner_id=1009 

curl -X POST "https://apis.buzzboard.com/v4.0/prospects/createmany"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
"data": {
    "prospects": [
      {
        "business_name": "Dev Company",
        "website": "https://dev.com",
        "phone": "(908) 998-9898",
        "contact_info": {
          "first_name": "john",
          "last_name": "Mathew",
          "email": "johnmathew@gm.com",
          "mobile": "5417543011",
          "title": "Mr",
          "phone": "(541) 754-3010"
        },
        "address": {
          "line1": "34 Old Compton Street",
          "city": "London",
          "zip": "12365",
          "state": "FL",
          "country": "United States"
        },
        "primary_category_id": 57,
        "secondary_category_id": 45,
        "keywords": [
          "My Business",
          "Business",
          "Only Business"
        ]
      },
      {
        "business_name": "Dev2 Company",
        "website": "https://devcom.com",
        "phone": "(988) 998-9898",
        "contact_info": {
          "first_name": "johns",
          "last_name": "Mathews",
          "email": "johnmathesw@gm.com",
          "mobile": "5418543011",
          "title": "Mr",
          "phone": "(541) 754-8010"
        },
        "address": {
          "line1": "34 Old Compton Street",
          "city": "London",
          "zip": "23654",
          "state": "FL",
          "country": "United States"
        },
        "primary_category_id": 57,
        "secondary_category_id": 45,
        "keywords": [
          "Business",
          "Dev Business",
          "Only Dev Business"
        ]
      }
    ],
    "callback_url": "https://requestb.in/176r7bl1",
    "owner_id": 1009
  }
}'
{
  "data": {
    "job_id": "lXERIj1xZKIbFMIR"
  }
}

Prospect - Search Many v4.0

Searches multiple prospects based on the requested search parameters and a callback URL will be invoked by the API method you are calling.

https://apis.buzzboard.com/v4.0/prospects/searchmany

Parameters

Field Type Description
search_params Required

Object

Prospect's possible search parameters. You can send array of search parameters. For more information about the parameters to send in the search_params object see Search Params Info.

auto_add Required

Boolean

For automatically adding prospects to BuzzBoard. It would get added if the value is true. If false the matched results will be returned to the callback_url.

owner_id

Number

The unique identifier of the user.

callbackurl

String

Callback URL to be invoked by the API method you're calling after it's done. 

curl -X POST "https://apis.buzzboard.com/v4.0/prospects/searchmany"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
"data": {
  "search_params":
	[
          {
            "business_name": "Erwin Pearl Inc",
            "business_zipcode": "77056",
            "business_phone": "",
            "business_website" : "",
            "combination_type" : "BZ"	 
          },
          {
            "business_name": "Walgreens",
            "business_zipcode": "",
            "business_phone": "7037290693",
            "combination_type": "BP"	
         },
	 {
            "business_name": "Brittany Club",
            "business_zipcode": "",
            "business_phone": "",
            "combination_type": "BZ"	
         }
	],
	"auto_add": false,
        "owner_id": 1009,
	"callbackurl": "enter the call back url here"
  }
}'

Prospect - Update v4.0

Updates your prospect information. If the prospect is not available in your account, this query will return an error.

https://apis.buzzboard.com/v4.0/prospects/{:id}

Parameters

Field Type Description
id Required

Number

Unique identifier of the prospect.

business_name Required

String

Name of the prospect.

website

String

Prospect's website. Required unless city and state fields are provided.

phone

String

Prospect's phone number.

contact_info

Object

Prospect's contact information. For more information about thecontact_info object see Contact Info.

address

String

Prospect's address information. For more information about the address object see Address.

latitude

Number

The latitude of prospect’s location.

longitude

Number

The longitude of prospect’s location.

favourite

Number

The prospects which are marked as Favorite by the user.

is_monitored

Number

The prospects which are marked by the user for monitoring.

monitored_on

Number

This gives information on when the prospect was monitored.

primary_category_id

Number

Primary Category Id of the prospect.

secondary_category_id

Number

Secondary Category Id of the prospect.

score

Object

Score for the prospect. For more information about the score object see Score.

keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]

external_id

String

An Id you can use to link BuzzBoard prospect to local records.

created_at

Number

Date and time of the creation in Unix timestamp format.

updated_at

Number

Date and time of the last update to the user in Unix timestamp format.

Updates a prospect with Id 1.

curl -X PUT "https://apis.buzzboard.com/v4.0/prospects/1"
-H "Authorization: Bearer $ACCESS_TOKEN" 
-H "Content-Type: application/json"
-d '{
  "data": {
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3111",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "keywords": [
      "My Business for Everything",
      "By Business",
      "Only Business"
    ],
    "external_id": "1237"
  }
}'
{
  "data": {
    "id": 1,
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3111",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "score": {
      "value": "P",
      "color": "#0000E9"
    },
    "external_id": "1237",
    "created_at": 1489750959,
    "updated_at": 1489790989
  }
}

Prospect - Change Owner v4.0

Changes the ownership of a prospect.

https://apis.buzzboard.com/v4.0/prospects/changeowner

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.

new_owner_id Required

Number

The unique identifier of the new owner.

Updates a prospect owner with prospect Id 1.

curl -X PUT "https://apis.buzzboard.com/v4.0/prospects/changeowner" 
-H "Authorization: Bearer $ACCESS_TOKEN" 
-H "Content-Type: application/json"
-d '{
  "data": {
    "prospect_id":1,
    "new_owner_id": 2
  }
}'
{
  "status": 200,
  "message": "Success"
}

Prospect - Regenerate v4.0

Regenerates a prospect to reanalyze the data and update the details.

https://apis.buzzboard.com/v4.0/prospects/regenerate

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.

Regenerates a prospect with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/prospects/regenerate"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
  "data": {
    "prospect_id":1
  }
}' 
{
  "status": 200,
  "message": "Success"
}

Prospect - Get Details v4.0

Retrieves details of a single prospect such as business name, contact information, and address.

https://apis.buzzboard.com/v4.0/prospects/1

Parameters

Field Type Description
prospect_id Required

Number

Unique identification of the prospect. 

curl -X GET "https://apis.buzzboard.com/v4.0/prospects/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "prospect_id": 1,
  "data": {
    "id": 1,
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3010",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "latitude": "28.0136642",
    "longitude": "-82.7827283",
    "favourite": 0,
    "is_monitored": 0,
    "monitored_on": null,
    "primary_category_id": 414,
    "secondary_category_id": 973,
    "score": {
      "value": 69,
      "color": "#80ca01"
    },
    "external_id": "1237",
    "created_at": 1489735430,
    "updated_at": 1491993018
  }
}

Prospect - Assets v4.0

Retrieves a list of the documents (assets) available for the prospect.

https://apis.buzzboard.com/v4.0/prospects/assets

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/prospects/assets?prospect_id=1

title

String

The document title.

type

String

The type of document.

url

String

The URL of the asset. 

curl -X GET "https://apis.buzzboard.com/v4.0/prospects/assets?prospect_id=1" 
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "title": "Business Insights",
      "type": "insights_business",
      "url": "https://sales.buzzboard.com/assetsurl_887cc3a363"
    },
    {
      "title": "Category Insights",
      "type": "insights_category",
      "url": "https://sales.buzzboard.com/assetsurl_887cc35678"
    },
    {
      "title": "Game Plan",
      "type": "insights_gameplan",
      "url": "https://sales.buzzboard.com/assetsurl_887cc28976"
    },
    {
      "title": "Profile Report",
      "type": "profile",
      "url": "https://sales.buzzboard.com/assetsurl_887cc10954"
    },
    {
      "title": "Competitors Report",
      "type": "competitors_pdf",
      "url": "https://sales.buzzboard.com/assetsurl_887cc01234"
    }
  ]
}

Prospect - Search Params

The search_params object is used for search and searchmany.

Field Type Description
business_name

String

Name of the prospect. Required when requested in combination_type.

zipcode

String

Prospect's zipcode. Required when requested in combination_type.

website

String

Prospect's website. Required when requested in combination_type.

phone

String

Prospect's phone number. Required when requested in combination_type.

combination_type Required

String

Any one of the combination needs to be passed in the search parameters: "BZ - Business Name & Zip", "BP - Business Name & Phone", "PH - Phone", "WS - Website".

Prospect - Contact Info

The contact_info object is used across all Prospects APIs.

Field Type Description
first_name

String

First name of the contact.

last_name

String

Last name of the contact.

email

String

Email address of the contact.

phone

String

Phone number of the contact.

mobile

String

Mobile number of the contact.

title

String

Title of the contact.

Prospect - Address

The address object is used across all Prospects APIs.

Field Type Description
line1

String

Number, street, suite, or apartment number.

city

String

City name.

zip

String

Postal code.

state

String

State name.

country

String

Country name.

Prospect - Score

The score object is used across all Prospects APIs.

Field Type Description
value

Number

This is the BuzzScore that is given to each prospect based on it's digital health.

color

String

Color of the stage, in hexadecimal format (such as "#0343ff").

Engagements

The Engagements API allows you to manage your notes and/or reminders. You can create, delete, and update a note, or set a reminder associated with a note. You can also retrieve a single note or reminder or get the entire list.

PROPERTIES

The following properties are for use with the Engagements API.

Field Type Description
id

Number

The unique identifier of the note/reminder.
type New

String

Name of the type of resource. Possible values:

  • note
  • reminder
  • email
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="email"
title

String

The note/reminder title.
content

Text

The note/reminder content.
reminder_date

Number

Date and time that we should send you a reminder in UNIX timestamp format.
google_sync New

Boolean

Status for whether or not you need to sync the inserted record into 'Google Calendar'.
crm_sync New

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).
creator_id

Number

The unique identifier for the creator of the note/reminder.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the engagement in Unix timestamp format.

ENDPOINTS

Engagements - List v4.0

Retrieves a list of all notes, reminders and emails associated with a prospect.

https://apis.buzzboard.com/v4.0/engagements

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/engagements?prospect_id=1

page_no

Number

Starting page number. By default page number starts from 1. If page_no is not specified, the returned records will start from first page. (e.g.) https://apis.buzzboard.com/v4.0/engagements?page_no=1

page_limit

Number

Number of records to be returned per page.(e.g.) https://apis.buzzboard.com/v4.0/engagements?page_limit=10

type Required

String

Name of the type of resource. Possible values:

  • note
  • reminder
  • email
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="email"

Returns list of all engagements of a prospect with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/engagements?prospect_id=1&type=reminder"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "id": 1,
      "type": "reminder",
      "title": "Ray Design Works",
      "content": "I tried the much touted Penultimate, and Sundry Notes, and UYH but this is the only app that thoroughly delighted me. It has everything I wanted.",
      "reminder_date": 14900046111,
      "creator_id": 1,
      "created_at": 1491991137,
      "updated_at": 1492093357
    },
    {
      "id": 2,
      "type": "reminder",
      "title": "Astra World",
      "content": "For nearly sixty years, Notes has presented interesting, informative, and well-written articles on music librarianship, music bibliography, the music trade, ...",
      "reminder_date": 1490004610,
      "creator_id": 1,
      "created_at": 1491915863,
      "updated_at": 1491917394
    }
  ],
  "meta": {
    "count": 2
  }
}

Engagements - Create v4.0

Adds a new note or sets a reminder for a prospect.

https://apis.buzzboard.com/v4.0/engagements

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.

type Required

String

Name of the type of resource. Possible values:

  • note
  • reminder
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="note"

title Required

String

Engagement title.

content

Text

The engagement content.

reminder_date

Number

Date and time that we should send you a reminder in UNIX timestamp format.

google_sync

Boolean

Status for whether or not you need to sync the inserted record into 'Google Calendar'.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).

Creates an engagement with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/engagements"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"

-d '{
  "data": {
    "prospect_id": 1,
    "type": "reminder",
    "title": "Follow up Mathew on a deal",
    "content": "Follow up Mathew on a deal over phone call.",
    "reminder_date": 1490023847
  }
}'
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "title": "Follow up Mathew on a deal",
    "type": "reminder",
    "content": "Follow up Mathew on a deal over phone call.",
    "reminder_date": 1490023847,
    "creator_id": 1,
    "created_at": 1489732132,
    "updated_at": 1489732132
  }
}

Engagements - Update v4.0

Updates the information of an existing note or reminder associated with a prospect. If the prospect is not available in your account, the request will return an error.

https://apis.buzzboard.com/v4.0/engagements/{:id}

Parameters

Field Type Description
id Required

Number

Unique identifier of an engagement.

prospect_id

Number

The unique identifier of the prospect.

title

String

Engagement title.

content

Text

The engagement content.

reminder_date

Number

Date and time that we should send you a reminder in UNIX timestamp format.

type Required

String

Name of the type of resource. Possible values:

  • note
  • reminder
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="note"

Updates engagement with Id 1.

curl -X PUT "https://apis.buzzboard.com/v4.0/engagements/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
    "data": {
      "title": "Call Customer",
      "content": "Need to discuss on proposal",
      "reminder_date": 1490023947
    }
}'
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "title": "Call Customer",
    "content": "Need to discuss on proposal",
    "reminder_date": 1490023947,
    "creator_id": 1,
    "created_at": 1490023456,
    "updated_at": 1490023719
  }
}

Engagements - Delete v4.0

Deletes any existing note or reminder associated with a prospect. If the Engagement Id does not exist, this request will return an error.

Once deleted, you won't be able to undo this action.

https://apis.buzzboard.com/v4.0/engagements/{:id}

Parameters

Field Type Description
id Required

Number

Engagement Id to be deleted.

type

String

Name of the type of resource. Possible values:

  • note
  • reminder
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="note"

Delete an engagement with Id 1.

curl -X DELETE "https://apis.buzzboard.com/v4.0/engagements/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
"HTTP/1.1 204 No Content"

Engagements - Get Details v4.0

Retrieves details of a particular Engagement note or reminder.

https://apis.buzzboard.com/v4.0/engagements/{:id}

Parameters

Field Type Description
id Required

Number

Engagement Id.

type

String

Name of the type of resource. Possible values:

  • note
  • reminder
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="note"

Returns details of an engagement with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/engagements/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "type": "reminder",
    "title": "Call Customer",
    "content": "Need to discuss on proposal",
    "reminder_date": 1489984299,
    "creator_id": 1,
    "created_at": 1489683385,
    "updated_at": 1489684248
  }
}

Contacts

The Contacts API allows you to manage your contacts. A contact represents an individual (for example,. Justin Taylor) or an organization (like BuzzBoard). You can create, delete and update your contacts. You can retrieve individual customers, as well as a list of all customers.

PROPERTIES

The following properties are for use with the Contacts API.

Field Type Description
id

Number

Unique identifier of the contact.
prospect_id

Number

Prospect Id associated with the contact.
first_name

String

The contact's first name.
last_name

String

The contact's last name.
phone

String

The contact's phone number.
mobile

String

The contact's mobile number.
title

String

The contact's title.
email

String

The contact's email address.
google_sync New

Boolean

Status for whether or not you need to sync the inserted record into 'Google Contacts'.
crm_sync New

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).
creator_id

Number

The unique identifier of the user who created the contact.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the contact in Unix timestamp format.

ENDPOINTS

Contacts - List v4.0

Retrieves all contact information available for a prospect.

https://apis.buzzboard.com/v4.0/contacts

Parameters

Field Type Description
prospect_id Required

Number

Prospect Id of the associate. (e.g.) https://apis.buzzboard.com/v4.0/contacts?prospect_id=1

page_no

Number

Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page.(e.g.) https://apis.buzzboard.com/v4.0/contacts?page_no=1

page_limit

Number

Number of records to return per page.(e.g.) https://apis.buzzboard.com/v4.0/contacts?page_limit=10

Returns all contacts available to the prospect with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/contacts?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
{
  "data": [
    {
      "id": 1,
      "prospect_id": 1,
      "contact_name": "Mark Taylor",
      "email": "marktaylor@buzzboard.com",
      "phone": "(541) 888-1234",
      "mobile": "5418881233",
      "title": "Mr",
      "creator_id": 1,
      "created_at": 1489752816,
      "updated_at": 1489752816
    },
    {
      "id": 2,
      "prospect_id": 1,
      "contact_name": "Mark Styne",
      "email": "markstyne@buzzboard.com",
      "phone": "(541) 754-3010",
      "mobile": "5417543011",
      "title": "Mr",
      "creator_id": 1,
      "created_at": 1489752449,
      "updated_at": 1489752449
    }
  ],
  "meta": {
    "count": 2
  }
}

Contacts - Create v4.0

Creates a new contact.

https://apis.buzzboard.com/v4.0/contacts

Parameters

Field Type Description
prospect_id Required

Number

Prospect Id associated.

first_name

String

The contact's first name.

last_name Required

String

The contact's last name.

email

String

The contact's email address.

phone

String

The contact's phone number.

mobile

String

The contact's mobile number.

title

String

The contact's title.

google_sync

Boolean

Status for whether or not you need to sync the inserted record into 'Google Contacts'.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).

Adds a new contact 'John Markson' to a prospect with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/contacts" 
-H "Authorization: Bearer $ACCESS_TOKEN" 
-H "Content-Type: application/json" 

-d '{
    "data": {
      "prospect_id": 1,
      "first_name": "John",  
      "last_name": "Markson",
      "email": "john.markson@buzzboard.com",
      "title": "Mr",
      "phone": "(541) 754-3010",
      "mobile": "5417543011"
    }
}'
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "first_name": "John",
    "last_name": "Markson",
    "email": "john.markson@buzzboard.com",
    "phone": "(541) 754-3010",
    "mobile": "5417543111",
    "title": "Mr",
    "creator_id": 1,
    "created_at": 1489653230,
    "updated_at": 1489653230
  }
}

Contacts - Update v4.0

Updates a contact information.

https://apis.buzzboard.com/v4.0/contacts/{:id}

Parameters

Field Type Description
id Required

Number

Contact Id.

prospect_id

Number

Prospect Id associated.

first_name

String

The contact's first name.

last_name Required

String

The contact's last name.

email

String

The contact's email address.

phone

String

The contact's phone number.

mobile

String

The contact's mobile number.

title

String

The contact's title.

Updates first_name, last_name, mobile, email and title of a contact with Id 1.

curl -X PUT "https://apis.buzzboard.com/v4.0/contacts/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json" 
-d '{ 
    "data": {
        "first_name": "Mark",
        "last_name": "Johnson",
        "phone":"(541) 888-1234"
        "mobile": "5418881233",
        "title": "Mr",
        "email": "mark.johnson@buzzboard.com"
      }
}'
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "first_name": "Mark",
    "last_name": "Johnson",
    "email": "mark.johnson@buzzboard.com",
    "phone": "(541) 888-1234",
    "mobile": "5418881233",
    "title": "Mr",
    "creator_id": 1,
    "created_at": 1489653230,
    "updated_at": 2597986459
  }
}

Contacts - Delete v4.0

Deletes a contact information. Once deleted, you won't be able to undo this action. If the Engagement Id does not exist, this request will return an error.

https://apis.buzzboard.com/v4.0/contacts/{:id}

Parameters

Field Type Description
id Required

Number

Contact Id.

Delete a contact with Id 1.

curl -X DELETE "https://apis.buzzboard.com/v4.0/contacts/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
"HTTP/1.1 204 No Content"

Contacts - Get Details v4.0

Retrieves a single contact available to the user.

https://apis.buzzboard.com/v4.0/contacts/{:id}

Parameters

Field Type Description
id Required

Number

The Id of the contact.

Returns details of a contact with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/contacts/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "first_name": "John",
    "last_name": "Markson",
    "email": "john.markson@buzzboard.com",
    "phone": "(541) 754-3010",
    "mobile": "5417543111",
    "title": "Mr",
    "creator_id": 1,
    "created_at": 1489653230,
    "updated_at": 1489653230
  }
}

Categories

The Categories API allows you to list the categories.

PROPERTIES

The following properties are for use with the Categories API.

Field Type Description
id

Number

Unique identifier of the Category.
name

String

Unique name of the Category.

ENDPOINTS

Categories - List v4.0

Retrieves a list of categories available.

https://apis.buzzboard.com/v4.0/categories

Returns a list of all categories available.

curl -X GET "https://apis.buzzboard.com/v4.0/categories"
-H "Authorization: Bearer $ACCESS_TOKEN
{
  "data": [
    {
      "id": 1,
      "name": "Abbey"
    },
    {
      "id": 2,
      "name": "Abortion Clinic"
    }
  ],
  "meta": {
    "count": 2
  }
}

Profile

The Profile API allows you to list the Profile elements.

PROPERTIES

The following properties are for use with the Profile API.

Field Type Description
prospect_id

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/profile/elements?prospect_id=1
grade

Object

Prospect's grade information. For more information about the grade object see Grade.

ENDPOINTS

Profile - Elements v4.0

Retrieves a list of profile elements.

https://apis.buzzboard.com/v4.0/profile/elements

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/profile/elements ?prospect_id=1

Returns list of all profile elements.

curl -X GET "https://apis.buzzboard.com/v4.0/profile/elements?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "sections": [
    {
      "key": "business_info",
      "name": "BUSINESS INFO",
      "elements": [
        {
          "key": "business_name",
          "name": "Business Name",
          "value": "Ihop"
        },
        {
          "key": "website_formatted",
          "name": "Website Formatted",
          "value": "http://restaurants.ihop.com"
        },
        {
          "key": "website",
          "name": "Website",
          "value": "http://restaurants.ihop.com"
        },
        {
          "key": "is_favorite",
          "name": "Is Favorite",
          "value": "No"
        },
        {
          "key": "phone",
          "name": "Phone",
          "data": {
            "value": "(920) 235-3411",
            "is_default": true
          }
        },
        {
          "key": "default_email",
          "name": "Default Email",
          "value": "media@ihop.com"
        },
        {
          "key": "email_list",
          "name": "Email List",
          "value": [
            "media@ihop.com",
            "media@ihop.com"
          ]
        },
        {
          "key": "status",
          "name": "Status",
          "value": true
        },
        {
          "key": "geo_lat",
          "name": "Geo Latitude",
          "value": 44.0060328
        },
        {
          "key": "geo_lng",
          "name": "Geo Longitude",
          "value": -88.5814649
        },
        {
          "key": "is_verified",
          "name": "Is Verified",
          "value": "No"
        },
        {
          "key": "address",
          "name": "Address",
          "address": {
            "street_address": "1400 S Koeller St",
            "city": "Oshkosh",
            "zip": "54902",
            "state": "WI",
            "country": "United States"
          }
        },
        {
          "key": "BuzzScore",
          "name": "BuzzScore",
          "value": 68
        },
        {
          "key": "additional_url",
          "name": "Additional URL",
          "value": ""
        }
      ],
      "ai_summary": "The Hearing Center of Northeast Pennsylvania, part of HearingLife, provides personalized hearing health solutions in Hawley, PA. Committed to improving quality of life, they offer hearing assessments, premium hearing aids, and tinnitus treatment. Customers appreciate their outstanding care, friendly service, and access to advanced hearing technology."
    },
    {
      "key": "advertising",
      "name": "Advertising",
      "description": "How much does the business spend on various modes of advertising to reach their target market?",
      "section_brief_desc": "Paid Advertising statistics.",
      "grade": {
        "value": "",
        "color": ""
      },
      "elements": [
        {
          "key": "dp_google_adword",
          "name": "Google Ads",
          "data": {
            "presence": true,
            "estimated_monthly_ad_spend": "$81,520 - $122,280"
          }
        },
        {
          "key": "display_ads",
          "name": "Display Ads",
          "data": {
            "presence": false
          }
        },
        {
          "key": "yelp_ads",
          "name": "Yelp Ads",
          "data": {
            "presence": true
          }
        },
        {
          "key": "fb_ads",
          "name": "Facebook Ads",
          "data": {
            "presence": -1
          }
        },
        {
          "key": "adv_home_advisor",
          "name": "HomeAdvisor",
          "data": {
            "presence": true
          }
        }
      ],
      "ai_summary": "The Hearing Center of Northeast Pennsylvania is investing in Google Ads but missing opportunities with Display, Yelp, and Instagram Ads. Expanding to these platforms can enhance their visibility, attract more leads, and improve conversions. Diversifying their ad spend and leveraging industry benchmarks for optimization will likely boost growth and customer acquisition."
    },
    {
      "key": "local_business_presence",
      "name": "Local Business Presence",
      "description": "Does the business have a listing on popular local search services/directories/guides that people use to find a local service, driving directions to the business and also read user reviews?",
      "section_brief_desc": "Directories increase the exposure of your business and its products. It is an effective way to increase your online visibility and customer conversion.",
      "grade": {
        "value": 61,
        "color": "#f0b030"
      },
      "elements": [
        {
          "key": "google_places",
          "name": "Google My Business Listed",
          "description": "Presence in local directories lets the business get found via local searches and also enhances its overall internet presence. A business must have a listing on Google Maps to share information about the service, its hours of operation, driving directions.",
          "data": {
            "Listed": true,
            "Claimed": true,
            "NAP": false
          },
          "signals": [
            {
              "key": "local_directory_googleplaces_reviews",
              "name": "No. of Google Reviews",
              "data": {
                "value": "1130"
              }
            },
            {
              "key": "local_directory_googleplaces_ratings",
              "name": "Google Review Rating",
              "data": {
                "value": "3.9"
              }
            }
          ]
        },
        {
          "key": "yelp",
          "name": "Yelp Listed",
          "description": "Businesses can have a listing on Yelp, where users can post reviews. It helps tap Yelp users who not only perform local search for a business, but also look for user reviews about it.",
          "data": {
            "Listed": true,
            "Claimed": true,
            "NAP": true
          },
          "signals": [
            {
              "key": "local_directory_yelp_reviews",
              "name": "No. of Yelp Reviews",
              "data": {
                "value": "27"
              }
            },
            {
              "key": "local_directory_yelp_ratings",
              "name": "Yelp Review Rating",
              "data": {
                "value": "2.5"
              }
            }
          ]
        },
        {
          "key": "nextdoor",
          "name": "Nextdoor Listed",
          "description": "nextdoor_desc",
          "data": {
            "Listed": true,
            "Claimed": true,
            "NAP": true
          },
          "signals": [
            {
              "key": "businesss_name",
              "name": "Business Name",
              "data": {
                "value": "Ihop"
              }
            },
            {
              "key": "recommendation",
              "name": "Recommendation",
              "data": {
                "value": "43"
              }
            },
            {
              "key": "neighborhood_favorite",
              "name": "Neighborhood Favorite",
              "data": {
                "value": true
              }
            },
            {
              "key": "lic_number",
              "name": "License",
              "data": {
                "value": ""
              }
            },
            {
              "key": "description",
              "name": "Description",
              "data": {
                "value": "Come Hungry. Leave Happy."
              }
            },
            {
              "key": "local_deals",
              "name": "Local Deals",
              "data": {
                "value": ""
              }
            }
          ]
        },
        {
          "key": "citysearch",
          "name": "Citysearch Listed",
          "description": "A listing in this popular online city guide can be used to post contact information, maps, driving directions. Citysearch also provides editorial and user reviews about a business.",
          "data": {
            "Listed": false,
            "Claimed": false,
            "NAP": null
          }
        },
        {
          "key": "yellow_pages",
          "name": "YP.com Listed",
          "description": "Yellow Pages listing is helpful for providing business information, map, directions and user reviews.",
          "data": {
            "Listed": true,
            "Claimed": false,
            "NAP": true
          }
        },
        {
          "key": "nokia_places",
          "name": "Here Maps Listed",
          "description": "When your business is on Here Maps, millions worldwide can search for and quickly locate you.",
          "data": {
            "Listed": true,
            "Claimed": false,
            "NAP": false
          }
        },
        {
          "key": "google_places_claimed",
          "name": "Google My Business Claimed",
          "data": {
            "Claimed": true
          }
        },
        {
          "key": "yelp_claimed",
          "name": "Yelp Claimed",
          "data": {
            "Claimed": true
          }
        },
        {
          "key": "citysearch_climed",
          "name": "Citysearch Claimed",
          "data": {
            "Claimed": false
          }
        },
        {
          "key": "yellow_pages_climed",
          "name": "YP.com Claimed",
          "data": {
            "Claimed": false
          }
        },
        {
          "key": "nokia_places_climed",
          "name": "Here Maps Claimed",
          "data": {
            "Claimed": false
          }
        }
      ],
      "ai_summary": ""
    }
  ],
  "context_ai_content": [
    {
      "_id": {
      },
      "summary": "Strengths:\n- High digital readiness score of 68\n- Strong backlink count\n- Effective Google Ads campaign with a spend of $6,610 - $9,916/mo\n- Comprehensive content analysis, including local phone number, address on homepage, map & directions, contact us, privacy policy, about page, services page, and FAQs\n- Active social media presence on Twitter, LinkedIn, Pinterest, and Instagram\n\nWeaknesses:\n- Lack of visibility for organic search traffic\n- No presence on Facebook\n- No rich snippets utilized\n- Incomplete content analysis, missing newsletter and business hours\n- Inconsistent use of image alt text\n\nOpportunities:\n- Enhanced SEO strategies, especially in using location in title tags and implementing SEO-friendly URLs\n- Expansion of advertising efforts to include display ads and Yelp ads\n- Improved backlink building to further boost search engine rankings\n- Employing rich snippets to enhance search engine visibility\n- Increased content engagement through the addition of a newsletter\n\nThreats:\n- Potential loss of market share to competitors with advanced SEO strategies\n- Risk of reduced visibility and traffic due to lack of rich snippets\n- Threat of a decline in organic search traffic if SEO strategies are not refined\n- Competitive disadvantage from the lack of presence on Facebook, impacting brand awareness and engagement\n- Risk of losing potential customers due to incomplete content analysis, specifically the absence of business hours and FAQs."
    },
    {
      "_id": {
      },
      "summary": "Strengths:\n1. Strong social media presence with active accounts on Facebook, Twitter, LinkedIn, Pinterest, and Instagram.\n2. Well-optimized website with a good amount of backlinks and a high domain authority score.\n3. Robust Google Ads spend with good traffic and keywords.\n4. Visible results in terms of search traffic and backlink analysis.\n5. High trust flow score, indicating a trustworthy website.\n\nWeaknesses:\n1. Lack of some SEO elements like including business location in title tags, ALT text for images, and SEO-friendly URLs.\n2. No display ads, Instagram ads, or rich snippets,  potentially hindering visibility.\n3. Inconsistent content participation with only a single YouTube subscriber and no newsletter.\n4. Some gaps in online content including the absence of FAQs, business hours, and testimonials on the website.\n5. Insufficient usage of Yelp ads, display ads, and limited online reputation marketing.\n\nOpportunities:\n1. Financial capacity available for improving digital marketing efforts, including optimization of Ads and presence in online search traffic.\n2. Expand social media efforts to include Facebook Ads, display ads, and richer content interaction to boost the outreach.\n3. Implementing additional SEO elements such as ALT text for images, FAQs, newsletters, and sef URLs can enhance organic search visibility.\n4. Opportunities for increasing online footprint by effectively using platforms such as Google Ads, Facebook Ads, and Instagram.\n\nThreats:\n1. Saturated local hearing health market with competing audiology centers heavily investing in digital marketing strategies.\n2. Threat of misleading and biased user reviews from the competitors about hearing aid details, prices, and services.\n3. Risk of negative online reputation marketing by competitors to spread disinformation and misinformation about the prospect Hearing Center and its offerings.\n4. Potential limitations to explore new marketing mediums may restrict avant-garde marketing strategies.\n5. A challenging background for organic search traffic due to high competitiveness in the hearing aid and assistive devices market."
    },
    {
      "_id": {
      },
      "summary": "1. The Hearing Center of Northeast Pennsylvania digital score of 68 indicates a strong digital maturity and readiness. \n2. Competitor 1, Integrity Audiology & Hearing Center, has a digital score of 57, indicating potential deficiencies in their digital strategy.\n3. Competitor 2, KUYKENDALL HEARING AID CENTERS, has a digital score of 59, showing areas for improvement in their digital strategy.\n4. Competitor 3, Integrity Audiology & Hearing Center, has a digital score of 60, indicating some areas for improvement in their digital strategy.",
      "display_prompt": "Analyze the digital deficiencies that may prevent the growth"
    }
  ],
  "conversation_ai_content": [
    {
      "_id": {
      },
      "summary": "1. \"I noticed that your website has a strong domain age of 18 years and 8 months, which is great for building trust with potential customers. How has this longevity helped your business in the local market?\"\n\n2. \"Your backlink count is quite impressive at 62,668, indicating a strong online presence. How do you think this has contributed to your visibility and customer acquisition in the digital space?\"\n\n3. \"I see that you are actively running Google Ads with a significant monthly spend. How has this advertising strategy impacted your lead generation and customer engagement?\"\n\n4. \"Your social media presence seems to be quite robust, with business accounts on Instagram, Twitter, LinkedIn, and Pinterest. How have these platforms helped in reaching and engaging with your target audience?\"\n\n5. \"I noticed that your website contains essential content elements such as contact information, maps, privacy policy, and service descriptions. How do you think these elements have contributed to your website performance and user experience?\""
    },
    {
      "_id": {
      },
      "summary": "1. Based on the digital state of the company, it seems that they have a strong online presence and a good level of digital maturity.\n2. The company website has a high domain URL age and a large employee size, indicating a well-established business.\n3. The company SEO analysis shows a strong presence in terms of on-page optimization, backlinks, and other key factors for improving search engine rankings.\n4. The company is actively engaged on social media platforms, with a presence on Twitter, YouTube, LinkedIn, Pinterest, and Instagram.\n5. The company content analysis indicates that they have the necessary information and content to engage their visitors, including local phone numbers, contact details, privacy policy, and services page.",
      "display_prompt": "Generate conversation starters to discuss the prospect goals and objectives, and how our product/service can help achieve them."
    },
    {
      "_id": {
      },
      "summary": "1. It looks like the HearingLife of Ponca City OK has a well-established digital presence, with a domain age of 18 years and strong SEO and advertising strategies in place.\n2. With over 1000 employees, they seem to be a significant player in the industry and a strong potential client for our digital marketing services.\n3. Their visible results and tailored SEO strategy could further benefit from our digital advertising services to increase their online visibility and attract more potential customers.\n4. Based on their competitors digital maturity and readiness scores, it seems there room for improvement to outperform their competitors and dominate the digital space in the industry.\n5. I propose discussing our SEO and digital advertising strategies in more detail to show how we can amplify their online presence and stand out in the digital landscape.",
      "display_prompt": "Generate conversation starters to discuss the prospect goals and objectives, and how our product/service can help achieve them."
    }
  ],
  "competition_analysis": [
    {
      "_id": {
      },
      "summary": "Integrity Audiology & Hearing Center\n- Newer domain with emerging online presence\n- Lower domain authority, but has dedicated SEO optimizations like rich snippets and location in titles\n- Presence on select social media platforms like Facebook\n- Basic content features in place, though lacks business hours and FAQs on the site\n- Limited backlinks and trust flow, indicating less established digital footprint\n\n Comparison Analysis:\nCompared to Hearinglife Of Ponca City Ok, Integrity Audiology & Hearing Center has a less mature online presence, lower SEO influence, fewer backlinks, and a lower domain authority, suggesting a smaller digital footprint but with fundamental SEO in place.\n\n Suggestion:\nHearinglife Of Ponca City Ok can capitalize on their robust digital presence by enhancing mobile page load speed and engaging in more diverse social media advertising to further outshine competitors like Integrity Audiology & Hearing Center."
    }
  ],
  "customer_analysis": [
    {
      "_id": {
      },
      "summary": "$$$Customer Segmentation\n\nMature Adults with Hearing Challenges: Individuals typically over the age of 50 who are experiencing hearing loss or impairment and are seeking solutions to improve their quality of life.\nYounger Adults and Caretakers: A younger demographic that includes adults caring for aging parents or relatives with hearing difficulties, as well as those in their late 30s and 40s beginning to notice changes in their hearing.\nHealth-Conscious Community Members: People of all ages with a focus on overall health and well-being who recognize the importance of hearing health as part of their lifestyle.\nTech-Savvy Consumers: Individuals who are interested in the latest technology and innovations in hearing aids and auditory support devices.\n\n$$$Buying Behavior\n\nMature Adults with Hearing Challenges: Value personalized service and trust, often seeking referrals from their primary care doctors; they prefer to invest in high-quality, durable hearing aids and appreciate follow-up care.\nYounger Adults and Caretakers: May prioritize convenience, looking for flexible appointment scheduling and fast service for their parents or relatives; they often conduct online research before making decisions.\nHealth-Conscious Community Members: Interested in preventative care and may opt for regular check-ups; they value educational content on the impact of hearing on overall health.\nTech-Savvy Consumers: Look for the latest features in hearing aids, such as Bluetooth connectivity and smartphone compatibility; they are likely to compare specs and reviews online before purchasing.\n\n$$$Customer Need & Preference\n\nQuality of Care: Customers prioritize professional, knowledgeable staff and a high level of care, with an emphasis on thorough hearing assessments and clear explanations of options.\nAdvanced Technology: A preference for state-of-the-art hearing aids with cutting-edge features that enhance not just hearing but also quality of life.\nCustomer Service: A strong desire for friendly, personable service where staff recognize individuals by name and provide a welcoming environment.\nAccessibility and Convenience: The need for easy access to the facility, flexible scheduling, and prompt service.\n\n$$$Customer Value Proposition\n\nMature Adults with Hearing Challenges: Offering a comprehensive auditory health experience that combines expert care with advanced hearing aid technology, enhancing everyday communication and life enjoyment.\nYounger Adults and Caretakers: Providing a stress-free experience with educational resources, straightforward guidance, and support in managing an elder hearing health.\nHealth-Conscious Community Members: Emphasizing the importance of hearing health in overall well-being, offering regular check-ups, and educating customers on how to maintain a healthy auditory lifestyle.\nTech-Savvy Consumers: Delivering the latest in hearing aid innovation with a range of products that cater to the desire for connectivity, discretion, and modern features."
    }
  ],
  "products": [
    {
      "_id": {
      },
      "product": "Search Engine Optimization",
      "package": "",
      "what": "The prospect website lacks Image Alt Text and Rich Snippets, which are crucial for improving search engine visibility and accessibility.",
      "soWhat": "Without these elements, the website may miss out on higher rankings in search results and fail to attract visually impaired users or those looking for specific information.",
      "nowWhat": "Implementing SEO strategies from Insights Dev will add Image Alt Text and Rich Snippets, enhancing the site visibility, accessibility, and overall user experience.",
      "stats": [
        {
          "Products": "Search Engine Optimization",
          "Source": "hubspot",
          "Stats": "34% of consumers prefer to learn about products by searching the internet, highlighting the importance of optimizing your website for SEO",
          "Links": "https://blog.hubspot.com/marketing/how-consumers-learn-about-products"
        },
        {
          "Products": "Search Engine Optimization",
          "Source": "ahrefs",
          "Stats": "68% of online experiences begin with a search engine",
          "Links": "https://ahrefs.com/blog/seo-statistics/"
        }
      ]
    },
    {
      "_id": {
      },
      "product": "Digital Advertising",
      "package": "",
      "what": "The company has no Display Ads or Yelp Ads running currently, limiting its reach to potential customers who frequent these platforms.",
      "soWhat": "Without leveraging these advertising channels, the company may miss opportunities to engage with a broader audience and drive more traffic to their site.",
      "nowWhat": "Utilizing Insights Dev Digital Advertising services will help create targeted Display Ads and Yelp Ads campaigns that increase brand awareness and attract more visitors.",
      "stats": [
        {
          "Products": "Digital Advertising",
          "Source": "backlinko",
          "Stats": "49% of businesses say that organic search brings them the best marketing ROI.",
          "Links": "https://backlinko.com/seo-stats"
        },
        {
          "Products": "Digital Advertising",
          "Source": "g2",
          "Stats": "On averagee, consumers see 5,000 ads every single day.",
          "Links": "https://learn.g2.com/digital-marketing-statistics"
        },
        {
          "Products": "Digital Advertising",
          "Source": "g2",
          "Stats": "Digital advertisements can increase a brand\u2019s awareness by 80%.",
          "Links": "https://learn.g2.com/digital-marketing-statistics"
        }
      ]
    },
    {
      "_id": {
      },
      "product": "Social Advertising",
      "package": "",
      "what": "The company social media engagement is low on platforms like YouTube (only 1 subscriber) despite having accounts on multiple platforms.",
      "soWhat": "Low engagement can result in missed opportunities for customer interaction, brand loyalty building, and driving traffic back to their main site.",
      "nowWhat": "Implementing targeted social ad campaigns through Insights Dev will boost visibility across all social media channels, drive engagement rates up significantly, and help attract more followers.",
      "stats": [
        {
          "Products": "Social Advertising",
          "Source": "webfx",
          "Stats": "32% of advertisers say that video is the most effective social ad format",
          "Links": "https://www.webfx.com/blog/social-media/social-media-advertising-statistics/"
        }
      ]
    }
  ],
  "meta": {
    "last_generated": 1492584540,
    "prospect_id": 1
  }
}

Profile - Grade

The grade object is used across all Elements APIs

Field Type Description
value

Number

Grade value that is calculated based on the elements in a particular section.

color

String

Returns the color code in hexadecimal format(such as "#0343ff").

Insights

ENDPOINTS

Insights - Insights v4.0

Retrieves a list of all AI elements.

https://apis.buzzboard.com/v4.0/insights

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.

section_key Required

Array

Array of keys to get the data for different sections, such as ["multi-screen-analysis", "ecommerce-growth-analysis", "on-page-seo-analysis", "advertising-landscape-analysis", "social-presence-performance-analysis", "content-analysis-website", "infrastructure-resilience-review", "google-reviews-reputation", "local-competition", "local-competition-analysis", "serp-competition", "serp-competition-analysis", "category-insights-media-sales-opportunities", "category-insights-technology-trends", "category-insights-industry-background", "category-insights-industry-threats-opportunities", "category-insights-other-important-facts", "category-insights-know-their-customers", "swot-analysis-strengths", "swot-analysis-weakness", "swot-analysis-opportunities", "swot-analysis-threats", "d-score", "advertising-composite-score", "security-composite-score", "social-score", "seo-score", "content-maturity-score", "multi-screen-compatibility-score", "local-business-presence-score", "monthly-app-spend", "monthly-app-spend-grade", "product-recommendations", "business-summary", "customer-segments", "customer-buying-behavior", "customer-needs-preferences", "customer-value-proposition", "need-gap-analysis", "target_customer", "growth-barriers", "business-improvement-proposals", "prospect_digital_state", "industry-trends", "goal-alignment", "pain-point-solutions", "process-improvement-insights"]

Returns list of given section elements.

curl -X POST "https://apis.buzzboard.com/v4.0/insights"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
  "prospect_id": 10499240,
  "section_key": [
        "multi-screen-analysis",
        "ecommerce-growth-analysis",
        "on-page-seo-analysis",
        "advertising-landscape-analysis",
        "social-presence-performance-analysis",
        "content-analysis-website"
]
}'
[
  {
    "section": "multi-screen-analysis",
    "data": "West Hills Honda's website is mobile-friendly and has a responsive design, ensuring broad accessibility and enhancing user-friendliness. However, the low mobile Page Speed Score of 38 suggests room for improvement in loading times, which is crucial for retaining visitors and optimizing the user experience. Addressing speed issues can significantly boost engagement and visitor retention."
  },
  {
    "section": "ecommerce-growth-analysis",
    "data": "West Hills Honda's strong e-commerce presence, featuring interactive widgets, coupons, and promotions, enhances customer engagement and satisfaction. However, the absence of order tracking and marketplace listings may limit reach and convenience. Boosting these aspects could further drive growth and improve competitiveness in the digital landscape."
  },
  {
    "section": "on-page-seo-analysis",
    "data": "West Hills Honda's SEO is solid with compliance in key areas like title tags, meta descriptions, and alt text. However, improving domain authority and trust flow, and implementing SEF URLs can enhance search rankings. Increasing backlinks and optimizing content further can improve website performance and reach."
  },
  {
    "section": "advertising-landscape-analysis",
    "data": "West Hills Honda shows robust online advertising engagement with Google and Display Ads, capturing significant impressions. However, opportunities exist to diversify their strategy by expanding into Yelp and Instagram Ads to enhance lead capture and conversion. Optimizing existing campaigns and exploring underutilized platforms can improve reach and customer acquisition, aligning with industry growth benchmarks."
  },
  {
    "section": "social-presence-performance-analysis",
    "data": "West Hills Honda's social media presence shows strength on Facebook with 2,517 likes and robust engagement through 4,055 check-ins. Their Instagram account, with 1,015 followers, suggests room for growth in audience reach and engagement. Twitter and Pinterest accounts add diversity but lack prominent influence. Absence on YouTube could mean missing out on video marketing opportunities. They can enhance their strategy by boosting Instagram activities and integrating video content to expand their reach and strengthen engagement across platforms."
  },
  {
    "section": "content-analysis-website",
    "data": "West Hills Honda's website is well-structured with essential pages like Contact, Services, and About, which facilitate customer engagement and drive traffic. The absence of a newsletter could limit ongoing engagement and lead nurturing. The presence of local contact details and a dedicated Used Cars page caters to diverse customer needs, enhancing conversion potential. To further boost engagement and conversion, consider integrating a newsletter feature and optimizing content for SEO to attract more organic traffic."
  }
]

Jobs

The Jobs API allows you to list the Details of the job.

PROPERTIES

The following properties are for use with the Jobs API.

Field Type Description
job_id

String

The unique identifier of the job.(e.g.) ?job_id=crP5khUAJYsOgiS5

ENDPOINTS

Jobs - Get Details v4.0

Retrieves the details of job.

https://apis.buzzboard.com/v4.0/jobs?job_id={id}&module_id={moduleName}

Parameters

Field Type Description
job_id Required

String

The unique identifier of the job.(e.g.) ?job_id=crP5khUAJYsOgiS5

module_id

String

The name of the module.(e.g.) ?module_id=createmany Possible module idscreatemany, search, searchmany Default value is createmany 

curl -X GET "https://apis.buzzboard.com/v4.0/jobs?job_id=crP5khUAJYsOgiS5&module_id=createmany" 
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": {
    "status": "Completed",
    "id": "crP5khUAJYsOgiS5",
    "created_at": 1492493949,
    "count": {
      "total": 2,
      "completed": 1,
      "inqueue": null,
      "failed": 1
    }
  }
}

Competition

The Competition API allows you to add, delete, convert to prospect, and other details of a competitor.

PROPERTIES

The following properties are for use with the Competition API.

Field Type Description
prospect_id

Number

The unique identifier of the prospect. (e.g.) https://apis.buzzboard.com/v4.0/competition?prospect_id=1
business_name

String

Name of the competitor.
website

String

Competitor's website. Required unless city and state fields are provided.
address

String

Competitor's Address information.For more information about address object see Address.
phone

String

Competitor's phone number.

ENDPOINTS

Competition - List v4.0

Retrieves all competitor's information available for the requested prospect.

https://apis.buzzboard.com/v4.0/competition

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect. (e.g.) https://apis.buzzboard.com/v4.0/competition?prospect_id=1

Returns all competitors available to the prospect with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/competition?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
{
  "data": [
    {
      "id": 2074304,
      "business_name": "Pantaloons",
      "website": "https://www.pantaloons.com",
      "phone": "(541) 754-3011",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "state": "GA",
        "zip": "12345",
        "country": "United States"
      },
      "score": {
        "value": "85",
        "color": "#03b377"
      },
      "created_at": 1492585472,
      "updated_at": 1492585472
    },
    {
      "id": 2074305,
      "business_name": "Toyotas",
      "website": "https://www.toyota.com",
      "phone": "(541) 754-3010",
      "address": {
        "line1": "115 lake ville",
        "city": "New York",
        "state": "NY",
        "zip": "12345",
        "country": "United States"
      },
      "score": {
        "value": "76",
        "color": "#f0b030"
      },
      "created_at": 1492585472,
      "updated_at": 1492585472
    }
  ],
  "meta": {
    "count": 2
  }
}

Competition - Add v4.0

Creates a new single or multiple competitor(s).

https://apis.buzzboard.com/v4.0/competition

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect. (e.g.) https://apis.buzzboard.com/v4.0/competition ?prospect_id=1

business_name Required

String

Name of the competitor.

website

String

Competitor's website. Required unless city and state fields are provided.

address Required

String

Competitor's Address information. For more information about the address object see Address.

phone

String

Competitor's phone number.

Add a new competitors to a prospect with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/competition?prospect_id=1" 
-H "Authorization: Bearer $ACCESS_TOKEN" 
-H "Content-Type: application/json" 

-d '{
  "data": [
    {
      "business_name": "Pantaloons",
      "website": "https://www.pantaloons.com",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "zip": "12345",
        "state": "GA"
      },
      "phone": "(541) 754-3011"
    },
    {
      "business_name": "Toyotas",
      "website": "https://www.toyota.com",
      "address": {
        "line1": "115 lake ville",
        "city": "New York",
        "zip": "12345",
        "state": "NY",
        "country": "United States"
      },
      "phone": "(541) 754-3010"
    }
  ]
}' 
{
  "data": [
    {
      "id": 2074304,
      "business_name": "Pantaloonss",
      "website": "https://www.pantaloons.com",
      "phone": "(541) 754-3011",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "state": "GA",
        "zip": "12345",
        "country": "United States"
      },
      "score": {
        "value": "P",
        "color": "#f0b030"
      },
      "created_at": 1492585472,
      "updated_at": 1492585472,
      "meta": {
        "status": 201,
        "message": "Competitor added successfully"
      }
    },
    {
      "id": 2074305,
      "business_name": "Toyotas",
      "website": "https://www.toyota.com",
      "phone": "(541) 754-3010",
      "address": {
        "line1": "115 lake ville",
        "city": "New York",
        "state": "NY",
        "zip": "12345",
        "country": "United States"
      },
      "score": {
        "value": "P",
        "color": "#f0b030"
      },
      "created_at": 1492585472,
      "updated_at": 1492585472,
      "meta": {
        "status": 201,
        "message": "Competitor added successfully"
      }
    }
  ]
}

Competition - Delete v4.0

Deletes a single or multiple competitor's information. Once deleted, you won't be able to undo this action. If the Competitor Id does not exist, this request will return an error.

https://apis.buzzboard.com/v4.0/competition/deletecompetitors

Parameters

Field Type Description
competitor_id Required

Number

The unique identifier of the competitor.

prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/competition/deletecompetitors?prospect_id=1

Delete a competitor with Id 2074057 to the prospect with Id 1.

curl -X DELETE "https://apis.buzzboard.com/v4.0/competition/deletecompetitors?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json" 
 
-d '{
  "data": [
    {
      "competitor_id": 2074057
    }
  ]
}'
"HTTP/1.1 204 No Content"

Competition - Convert v4.0

Converts the single or multiple competitor(s) to prospect(s).

https://apis.buzzboard.com/v4.0/competition/convert

Parameters

Field Type Description
competitor_id Required

Number

The unique identifier of the competitor.

prospect_id

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/competition/convert?prospect_id=1

Convert the competitor to prospect

curl -X PUT "https://apis.buzzboard.com/v4.0/competition/convert?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json" 
 
-d '{
  "data": [
    {
      "competitor_id": 2074077
    },
    {
      "competitor_id": 2074078
    }
  ]
}'
{
  "data": [
    {
      "id": 2074077,
      "business_name": "Harsha Toyota",
      "website": "https://www.harshatoyota.com",
      "phone": "(541) 754-3011",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "zip": "12345",
        "state": "GA",
        "country": "United States"
      },
      "score": {
        "value": 57,
        "color": "#f0b030"
      },
      "created_at": 1492585472,
      "updated_at": 1492585972,
      "meta": {
        "status": 200,
        "message": "Prospect added successfully"
      }
    },
    {
      "id": "2074078",
      "business_name": "Saboo Motors",
      "website": "https://www.saboomotors.com",
      "phone": "(541) 754-3010",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "zip": "12345",
        "state": "GA",
        "country": "United States"
      },
      "score": {
        "value": 67,
        "color": "#f0b030"
      },
      "created_at": 1492585772,
      "updated_at": 1492585872,
      "meta": {
        "status": 200,
        "message": "Prospect added successfully"
      }
    }
  ]
}

Responses

The BuzzBoard Ignite API uses standard HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx indicate an error with the provided information, and codes in the 5xx range indicate a server-side error. Contact your system administrator for additional information or for response codes not listed here.

Http status codes summary

Code Message Description
200 OK Everything worked as expected.
201 Created Everything worked as expected. Returned instead of 200 if your operation creates a new resource.
204 No Content Everything worked as expected. The response includes an empty body.
400 Bad Request Returned whenever the request is missing required information or is malformed in another way, e.g. the payload is malformed.
401 Unauthorized The API consumer credentials are invalid.
403 Forbidden The request has been refused because of insufficient user access privileges.
404 Not Found The requested resource could not be found.
405 Method Not Allowed The API consumer tried to access an endpoint with an invalid HTTP method, e.g. using PUT on a read-only resource.
408 Request Timeout Request Timeout.
429 Too Many Requests The rate limit was exceeded and access is temporarily blocked.
500 Internal Server Error Something went wrong on server side.
501 Not Implemented Not implemented.

Basic Structure

Parameters

Field Type Description
status

Number

The HTTP response code.
message

String

A message relating to the cause of the status.

 
{
  "error": {
    "status": 401,
    "message": "You are not authorized to request this service. Please contact support@buzzboard.com for further assistance."
  }
}
© 2025 BuzzBoard, Inc