TrueBiz Web Presence Review History API
Web Presence Review results are stored with TrueBiz until you request their deletion. These endpoints are designed to allow you to access these historical results.
OpenAPI Specification
openapi: 3.0.2
info:
title: TrueBiz Web Presence Review Async Web Presence Review Web Presence Review History API
version: 1.0.0
description: '# Introduction
TrueBiz provides tools to automate assessing a merchant''s web presence through the entire customer lifecycle.
# Authentication
All requests to TrueBiz require an API key to be sent as a header. The expected header name is "X-API-KEY".
'
servers:
- url: https://ae.truebiz.io
description: Production
tags:
- name: Web Presence Review History
description: '
Web Presence Review results are stored with TrueBiz until you request their deletion. These endpoints
are designed to allow you to access these historical results.
'
paths:
/api/v1/history/company:
get:
operationId: core_api_company_lookup_get_web_presence_reviews_history
summary: Get Web Presence Reviews History
parameters:
- in: query
name: min_datetime
schema:
title: Min Datetime
type: string
format: date-time
required: false
- in: query
name: max_datetime
schema:
title: Max Datetime
type: string
format: date-time
required: false
- in: query
name: search_term
schema:
title: Search Term
type: string
required: false
- in: query
name: include_monitoring
schema:
title: Include Monitoring
default: false
type: boolean
required: false
- in: query
name: include_internal
schema:
title: Include Internal
default: false
type: boolean
required: false
- in: query
name: include_errored
schema:
title: Include Errored
default: false
type: boolean
required: false
- in: query
name: limit
schema:
title: Limit
default: 50
type: integer
required: false
- in: query
name: offset
schema:
title: Offset
default: 0
type: integer
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PagedCompanyLookup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequest'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
tags:
- Web Presence Review History
security:
- ApiKeyAuth: []
- PropelAuthBearer: []
/api/v1/history/company/{request_id}:
get:
operationId: core_api_company_lookup_get_web_presence_review_history
summary: Get Web Presence Review History
parameters:
- in: path
name: request_id
schema:
title: Request Id
type: string
format: uuid
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyLookup'
'202':
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyLookup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequest'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
tags:
- Web Presence Review History
security:
- ApiKeyAuth: []
- PropelAuthBearer: []
components:
schemas:
InvalidInputParameter:
title: InvalidInputParameter
type: object
properties:
field_name:
title: Field Name
type: string
errors:
title: Errors
default: []
type: array
items:
type: string
required:
- field_name
example:
field_name: field1
errors:
- This field is required.
RiskAnalysis:
title: RiskAnalysis
type: object
properties:
fraud_risk:
$ref: '#/components/schemas/FraudRisk'
CompanyRevenue:
title: CompanyRevenue
description: An enumeration.
enum:
- 0-1M
- 1M-10M
- 10M-50M
- 50M-100M
- 100M-1B
- 1B+
type: string
core__api__schemas__policy_analysis__Analysis:
title: Analysis
type: object
properties:
question:
title: Question
description: The question that was asked.
example: Does the policy detail the website's privacy policy and how the data of customers is protected, used or disclosed?
type: string
answer:
title: Answer
description: The answer to the question.
example: 'Yes'
type: string
sources:
title: Sources
description: The sources of the answer.
example:
- https://www.acme.com/privacy
- https://www.acme.com/privacy2
type: array
items:
type: string
minLength: 1
maxLength: 2083
format: uri
required:
- question
- sources
CountryShare:
title: CountryShare
description: A single country's share of total website traffic.
type: object
properties:
value:
title: Value
type: number
change:
title: Change
type: number
name:
title: Name
type: string
abbr:
title: Abbr
type: string
InvalidRequest:
title: InvalidRequest
type: object
properties:
message:
title: Message
type: string
invalid_parameters:
title: Invalid Parameters
default: []
type: array
items:
$ref: '#/components/schemas/InvalidInputParameter'
required:
- message
example:
message: Invalid input.
invalid_parameters:
- field_name: field1
errors:
- This field is required.
- field_name: non_field_errors
errors:
- There's something strange in your input.
HistoricalArchive:
title: HistoricalArchive
type: object
properties:
url:
title: URL
description: The URL to access an archive.
example: '2021-12-15'
nullable: false
minLength: 1
maxLength: 65536
format: uri
type: string
taken_date:
title: Taken date
description: The date the archive was captured.
example: '2021-12-15'
nullable: false
type: string
format: date
Registrar:
title: Registrar
type: object
properties:
name:
title: Registrar name
description: The name of the registrar.
default: ''
example: MarkMonitor, Inc.
nullable: false
minLength: 1
maxLength: 2048
type: string
country:
title: Registrar country
description: The country the registrar is primarily located in.
default: ''
example: United States
nullable: false
minLength: 1
maxLength: 2048
type: string
website:
title: Registrar website
description: The primary website of the registrar.
example: https://markmonitor.com
nullable: true
minLength: 1
maxLength: 2083
format: uri
type: string
CustomerReviewsMeta:
title: CustomerReviewsMeta
type: object
properties:
last_review_date:
title: Last review date
description: The date the last review was made
type: string
format: date
url:
title: url
description: The URL of the company profile page
type: string
name:
title: Name
description: The name of the company as it appears on the company profile page
type: string
review_count:
title: Review count
description: The number of reviews for the company
default: 0
type: integer
review_average:
title: Review count
description: The average review rating
default: 0.0
type: number
Phone:
title: Phone
type: object
properties:
number:
title: Phone number
description: The E.164 formatted phone number.
example: '+13105555555'
nullable: false
type: string
is_valid:
title: Phone is valid?
description: A phone number that fits with known patterns such as area codes and carrier ranges.
example: true
nullable: true
type: boolean
line_type:
title: Phone line type
description: The type of phone line associated with this number
example: Mobile
nullable: true
allOf:
- $ref: '#/components/schemas/LineType'
country_code:
title: Country Code
description: ISO country code of country this phone number is from
example: US
nullable: true
type: string
country_name:
title: Country Name
description: The name of the country this phone number is from
example: United States
nullable: true
type: string
links_to_company:
title: Company linkages
description: Any current associations found between this number and the company
default: []
nullable: false
type: array
items:
$ref: '#/components/schemas/PhoneLink'
source:
title: Source
description: The data source for this number.
example: website
nullable: true
allOf:
- $ref: '#/components/schemas/DataSource'
ContentFlagDetail:
title: ContentFlagDetail
description: Structured detail for a triggered content flag.
type: object
properties:
flag:
title: Flag
description: The content flag category name.
allOf:
- $ref: '#/components/schemas/ContentFlagName'
reasoning:
title: Reasoning
description: Explanation for why this flag was triggered. Null when unavailable.
example: The page contains references to online casino games and sports betting.
type: string
location:
title: Location
description: URL of the page that was analyzed.
example: https://www.example.com/
type: string
required:
- flag
Coordinates:
title: Coordinates
type: object
properties:
lat:
title: Lat
type: number
lon:
title: Lon
type: number
required:
- lat
- lon
FraudRisk:
title: FraudRisk
description: An enumeration.
enum:
- LOW
- MEDIUM
- HIGH
type: string
ContentFlagName:
title: ContentFlagName
description: An enumeration.
enum:
- Adoption
- Adult
- Alcohol
- Animal Entertainment
- Asset Management
- Auctions
- Cannabis
- Career Placement Services
- Commodities or Securities Trading
- Counterfeit Goods and IP Infringement
- Credit Monitoring and Identity Protection Services
- Crowdfunding
- Cruise lines
- Crypto
- Cryptocurrency
- Dating
- Debt
- Discount and Rebate Services
- Endangered Animals
- Firearms
- Fireworks
- Fundraising
- Gambling
- Hazardous Materials
- High Risk Legal Services
- High Value Assets
- Informercials
- Insurance
- International Customs Services
- Lead Generation
- Leather and Taxidermy
- Lending
- Medical Devices
- Nutraceuticals
- Oil and gas
- Pet Stores
- Pharmaceuticals
- Pornography
- Prepaid Telephony
- Psychics and Fortune Tellers
- Real Estate
- Religious and Political Groups
- Scams and Scamware
- Scrap Metal
- Sex work
- Shell Companies
- Social Media Manipulation
- Solar
- Telehealth
- Telemarketing
- Timeshares
- Tobacco
- Weapons
- Web Hosting
- Government
type: string
PhoneLinkType:
title: PhoneLinkType
description: An enumeration.
enum:
- direct
- employee
- address
type: string
PostalServiceFlag:
title: PostalServiceFlag
description: '"residential" indicates that the address is a residential address.
"po_box" indicates that the address is a Postoffice Box rather than a physical address.
"virtual_address" indicates that the address is a private business receiving mail for clients.
"vacant" indicates that the USPS has marked the address as being vacant.
"inactive" indicates that the USPS does not deliver to this address.
"unreliable" indicates that that there was not enough address information to validate a specific address.
"unconfirmed" indicates that the USPS does not maintain Delivery Point Validation data for this address.'
enum:
- residential
- po_box
- virtual_address
- vacant
- inactive
- general_delivery
- unreliable
- unconfirmed
type: string
Industry:
title: Industry
type: object
properties:
primary_industry:
title: Primary industry
description: The primary industry the company operates in.
example: Iron and Steel Forging
nullable: true
minLength: 1
maxLength: 512
type: string
tags:
title: Tags
description: A list of short, descriptive phrases indicating what the company does.
default: []
example:
- Steelworks
- Anvils
- Coyotes
type: array
items:
type: string
primary_naics:
title: Primary NAICS code
description: A single code that is considered to be the primary business classification of the company according to the North American Industry Classification System (NAICS).
example: '332111'
type: string
additional_naics_codes:
title: NAICS codes
description: A list of codes indicating the industry classification of the company according to the North American Industry Classification System (NAICS).
default: []
example:
- '512110'
type: array
items:
type: string
primary_sic:
title: Primary SIC code
description: A single code that is considered to be the primary SIC of the company according to the Standard Industry Classification (SIC) system.
example: '3462'
type: string
additional_sic_codes:
title: SIC codes
description: A list of codes indicating the industry classification of the company according to the Standard Industry Classification (SIC) system.
default: []
example:
- '7819'
type: array
items:
type: string
primary_mcc:
title: Primary MCC code
description: A single code most likely to represent the company's merchant classification according to the Merchant Category Code (MCC) system.
example:
code: '3499'
description: Fabricated Metal Products, Not Elsewhere Classified
type: object
additional_mcc_codes:
title: SIC codes
description: A list of codes indicating other possible merchant classifications of the company according to the Merchant Category Code (MCC) system.
default: []
example:
- code: '7812'
description: Motion Picture and Video Tape Production and Distribution
type: array
items:
type: object
PolicyAnalysis:
title: PolicyAnalysis
type: object
properties:
sources:
title: Evaluated sources
description: A list of sources used in the analysis.
type: array
items:
$ref: '#/components/schemas/PolicySource'
analyses:
title: Analyses
description: A list of analytical findings from the source materials.
type: array
items:
$ref: '#/components/schemas/core__api__schemas__policy_analysis__Analysis'
CompanyType:
title: CompanyType
description: An enumeration.
enum:
- Corporation
- General Partnership
- Limited
- Limited Liability Company
- Limited Partnership
- Limited Liability Partnership
- Limited Liability Limited Partnership
- No Liability
- Non-Profit
- Professional Corporation
- Professional Limited Liability Corporation
- Sole Proprietorship
- Unlimited
type: string
CompanyMatchRequestStatuses:
title: CompanyMatchRequestStatuses
description: An enumeration.
enum:
- QUEUED
- PROCESSING
- FINISHED
- ERROR
type: string
Email:
title: Email
type: object
properties:
address:
title: Email address
description: The email address.
example: null
nullable: false
type: string
is_valid:
title: Email is valid?
description: An email that is not disposable, on a free host, and whose domain has DNS properly configured to receive emails.
example: true
nullable: true
type: boolean
internal_source_urls:
title: Internal Source URLs
description: A list of URLs where the email address was found within the searched website.
default: []
example:
- https://example.com/contact
nullable: false
type: array
items:
type: string
external_source_urls:
title: External Source URLs
description: A list of URLs where the email address was found, outside the searched website.
default: []
example:
- https://zoominfo.com/123
nullable: false
type: array
items:
type: string
source:
title: Source
description: The data source for this email.
example: website
nullable: true
allOf:
- $ref: '#/components/schemas/DataSource'
date_first_seen:
title: Date first seen
description: The date the email was first seen.
example: '2000-06-06'
nullable: true
type: string
format: date
velocity:
title: Velocity
description: A score representing activity over the last 6 months, out of 10.
example: 7
nullable: true
type: integer
popularity:
title: Popularity
description: A score representing breadth of interaction over the last 12 months, out of 10.
example: 9
nullable: true
type: integer
AddressCoordinatesAccuracy:
title: AddressCoordinatesAccuracy
description: Order matters here, list from least to most accurate
enum:
- APPROXIMATE
- ROOFTOP
type: string
CustomerReviews:
title: CustomerReviews
type: object
properties:
analysis:
title: Analysis
description: An analysis of the review data gathered from providers
allOf:
- $ref: '#/components/schemas/core__api__schemas__customer_review__Analysis'
providers:
title: Providers
description: A list of review data from different providers
default: []
type: array
items:
$ref: '#/components/schemas/CustomerReviewsData'
PhoneLink:
title: PhoneLink
type: object
properties:
type:
title: Link type
description: The type of link between this number and the company
example: direct
nullable: false
allOf:
- $ref: '#/components/schemas/PhoneLinkType'
duration:
title: Link duration
description: The approximate length of time the link has existed (formatted as an ISO 8601 duration)
example: P2Y5M
nullable: true
type: string
EmploymentRecord:
title: EmploymentRecord
type: object
properties:
company_name:
title: Company name
description: The company name.
example: ACME LLC.
type: string
title:
title: Job title
description: The job title.
example: Co-founder & CEO
type: string
start_date:
title: Start date
description: The date the person started at the job.
example: '2018-09-01'
type: string
format: date
required:
- company_name
PagedCompanyLookup:
title: PagedCompanyLookup
type: object
properties:
items:
title: Items
type: array
items:
$ref: '#/components/schemas/CompanyLookup'
count:
title: Count
type: integer
limit:
title: Limit
type: integer
offset:
title: Offset
type: integer
required:
- items
- count
- limit
- offset
Application:
title: Application
type: object
properties:
phone_business_connections:
title: phone has business connections?
description: The submitted phone number was found to have associations with the business.
example: true
type: array
items:
$ref: '#/components/schemas/DataSource'
email_business_connections:
title: email has business connections?
description: The submitted email was found to have associations with the business.
example: true
type: array
items:
$ref: '#/components/schemas/DataSource'
address_business_connections:
title: address has business connections?
description: The submitted address was found to have associations with the business.
example: true
type: array
items:
$ref: '#/components/schemas/DataSource'
person_business_connections:
title: person has business connections?
description: The submitted person was found to have associations with the business.
example: true
type: array
items:
$ref: '#/components/schemas/DataSource'
description:
title: Description
description: Does the submitted description describe what the business does?
example:
text: A used bookstore that also sells coffee and records
match_type: Full match
allOf:
- $ref: '#/components/schemas/SubmittedDescriptionAnalysis'
Decision:
title: Decision
description: An enumeration.
enum:
- Pass
- Fail
type: string
Metrics:
title: Metrics
type: object
properties:
estimated_employee_count_range:
title: Estimated employee count range
description: An estimated range showing the number of people working at the company.
example: 5,000+
nullable: true
allOf:
- $ref: '#/components/schemas/CompanySize'
estimated_annual_revenue_range:
title: Estimated annual revenue range
description: An estimated range showing the revenue of the company.
example: 1B+
nullable: true
allOf:
- $ref: '#/components/schemas/CompanyRevenue'
SearchModel:
title: SearchModel
description: An enumeration.
enum:
- STANDARD
- DEEP
type: string
TechSpendRecord:
title: TechSpendRecord
type: object
properties:
spend:
title: Spend
description: The estimated technology spend at a historical date.
example: 1000
type: integer
detected_date:
title: Date
description: The date of the estimate.
example: '2021-12-15'
type: string
format: date
LevelOfConcern:
title: LevelOfConcern
description: An enumeration.
enum:
- low
- medium
- high
- critical
type: string
ReferringSite:
title: ReferringSite
type: object
properties:
url:
title: URL
description: Link to the referring site.
example: null
nullable: false
minLength: 1
maxLength: 65536
format: uri
type: string
traffic_share:
title: Traffic Share
description: Share of total traffic coming from the referring traffic.
example: null
nullable: false
type: number
screenshot_image_link:
title: Screenshot Image
description: A link to the full website screenshot image.
example: null
nullable: false
minLength: 1
maxLength: 65536
format: uri
type: string
Person:
title: Person
type: object
properties:
name:
title: Name
description: The person's full name.
maxLength: 1024
minLength: 1
example: Dara Khosrowshahi
type: string
job_title:
title: Job title
description: A name that describes someone's job or position.
maxLength: 255
minLength: 1
example: Chief Executive Officer
type: string
linkedin_url:
title: LinkedIn URL
description: The person's LinkedIn profile URL.
maxLength: 1024
minLength: 29
example: https://www.linkedin.com/in/dara-khosrowshahi-9b1a8b/
type: string
profile_picture:
title: LinkedIn photo URL
description: The URL of the person's LinkedIn profile photo.
maxLength: 1024
minLength: 34
example: https://media.licdn.com/dms/image/D4D03AQGDnwFEps6idg/profile-displayphoto-shrink_200_200/0/1673360179524?e=1688601600&v=beta&t=bpXAkQdRR7liIMck3FQ7maRE-XeMwtChfWt73oB7YZ0
type: string
state_province:
title: State
description: The state or province where the person is located.
maxLength: 255
minLength: 1
example: California
type: string
city:
title: City
description: The city where the person is located.
maxLength: 255
minLength: 1
example: San Francisco
type: string
country:
title: Country
description: The country where the person is located.
maxLength: 255
minLength: 1
example: United States
type: string
start_date:
title: Start date
description: The date the person started at the company.
example: '1995-07-14'
nullable: true
type: string
format: date
other_active_positions:
title: Other active positions
description: Other jobs listed as currently active.
example: '[{"title": "CEO", "company_name": "ACME LLC.", "start_date": "2018-09-01"}]'
nullable: true
type: array
items:
$ref: '#/components/schemas/EmploymentRecord'
source:
title: Source
description: The data source for this person.
example: website
nullable: true
allOf:
- $ref: '#/components/schemas/DataSource'
TechActivityMonth:
title: TechActivityMonth
type: object
properties:
year:
title: Year
description: The year of the record.
example: 2022
type: integer
month:
title: Month
description: The month of the record.
example: 11
type: integer
added:
title: Added
description: The number of added website technologies during this month.
example: 5
type: integer
removed:
title: Removed
description: The number of removed website technologies during this month.
example: 5
type: integer
total:
title: total
description: The number of active website technologies during this month.
example: 5
type: integer
FootTraffic:
title: FootTraffic
type: object
properties:
projections:
title: Projections
description: List of daily projections zero-indexed starting on Monday
type: array
items:
$ref: '#/components/schemas/ProjectionDay'
traffic_score:
description: Score of the location's foot traffic
default: UNKNOWN
allOf:
- $ref: '#/components/schemas/TrafficScore'
hours_open:
title: Hours Open
description: Zero-indexed list of days starting with monday, each containg a list of hours the location is open
type: array
items:
type: array
items:
type: integer
TrafficSources:
title: TrafficSources
description: Traffic source breakdown as shares summing to ~1.0.
type: object
properties:
search:
title: Search
type: number
social:
title: Social
type: number
display_ads:
title: Display Ads
type: number
direct:
title: Direct
type: number
referrals:
title: Referrals
type: number
mail:
title:
# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/truebiz/refs/heads/main/openapi/truebiz-web-presence-review-history-api-openapi.yml