Business & Metrics

Business Endpoints

A Business represents the Enterprise or top-level entity responsible for managing their associated Business Units. The following endpoints are available at the Business level:

A GET action returning all available data for the specified business. This includes the Legal Name of the business, DBA, Primary Phone Number, aNumbers , Addresses, Admin Contacts, Website, Duns Number (if available), Business Units, Programs, and Delivery Channels. For a full example of the response object, please see the above-linked API reference page.

Business Metrics

Metrics associated with the entire Business may be called, returning aggregated answer rate, decline rate, and call count data. See detailed response information in the Get Business Metrics API reference.

📘

outputType

Each metrics request requires a designated "outputType" (i.e. daily, monthly, or all-time), returning metrics associated with the specified timeframe.

See sample Business metrics response object below:

{
    "body": {
        "businessMetricsSummaries": [
            {
                "businessId": "fb67b5c6-53e6-4e03-b775-d171289ebfbd",
                "metrics": [
                    {
                        "answerRate": 0.34526357,
                        "declineRate": 0.12345,
                        "totalTreatedCalls": 123453
                    }
                ]
            },
            {
                "businessId": "lb3bj1bf-53e6-4e03-b775-d171289ebfbd",
                "metrics": [
                    {
                        "answerRate": 0.34526357,
                        "declineRate": 0.12345,
                        "totalTreatedCalls": 123453
                    }
                ]
            }
        ]
    },
    "error": null
}

Business Contacts

A collection of endpoints offering the management of contacts associated with a specific Business.

A GET action returning all existing administrative contacts available for a specified Business.

A POST action providing the ability to add a new administrative contact to a specified Business.

A GET action returning all available data (i.e. Name, Email, Phone Number) for a specific contact within a Business.

A PUT action providing the ability to alter the information associated with a specific administrative contact.

A DELETE action that removes an individual contact from the specified Business.

Business Addresses

A collection of endpoints offering the management of addresses associated with a specified Business. All Businesses can assign a primary address, and secondary addresses as needed.

A GET action returning all existing addresses associated with a specified Business.

A POST action providing the ability to add a new address to a specified Business.

A GET action returning available address data (i.e. City, State, Postal Code, Country, Street Number) for a specified Business.

A PUT action providing the ability to alter existing information for a specified address.

A DELETE action removing an existing address from a Business.

Business Reference Data

A collection of endpoints offering data points for reference associated with Businesses.

A GET action that returns the industries a Business is defined as.

See sample Business industries reference data response object below

{
  "body":{
    "callPurposes":[
      { 
        "industryId":"12",
        "industry":"Automotive",
        "displayOrder":1
      },
      { 
        "industryId":"DC",
        "industry":"Business Services",
        "displayOrder":2
      },
    ]
  }
}

Business Industries:

industryIdindustrydisplayOrder
12Automotive1
17Business Services2
4Delivery/Shipping3
1Education4
7Financial5
5Government6
6Health Care7
18Hospitality/Entertainment8
19Insurance9
10Legal10
20Manufacturing11
24Non-Profit12
16Personal Services13
8Public Service14
9Real Estate15
13Religious16
11Restaurant/Food Services17
3Retail18
23Technology19
22Telecommunications20
15Trade Contractors21
2Transportation22
25Travel23
26Utilities24
14Veterinary Services25
21Other Businesses26
27Prison27

A GET action that returns the employee size of a business as a count range.

See sample Business employee count ranges reference data response object below:

{
  "body":{
    "employeeCountRanges":[
      { 
        "rangeId":9,
        "range":"Unknown",
        "displayOrder":1
      }
      { 
        "rangeId":1,
        "range":"1-10 employees",
        "displayOrder":2
      },
      { 
        "rangeId":2,
        "range":"11-51 employees",
        "displayOrder":3
      }
    ]
  }
}

Employee Count ranges:

rangeIdrangedisplayOrder
11-10 employees2
211-50 employees3
351-200 employees4
4201-500 employees5
5501-1000 employees6
61001-5000 employees7
75001-10,000 employees8
810,001 + employees9
9Unknown1