Skip to main content
GET
Get Business Score

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessID
string
required
Example:

"9289f785-e7f3-4c05-b5cc-6caf982bde63"

Query Parameters

year
integer

Optional. The exact year (4-digit) in which the score was generated. Because a business score can be generated multiple times, passing this historical parameter together with month returns the last score generated for that specific year/month period. If year and month are not supplied, the API defaults to the current year and returns the score generated in the current month.

Required range: 1900 <= x <= 9999
Example:

2025

month
integer

Optional. The exact month (1-12) in which the score was generated. Because a business score can be generated multiple times, passing this historical parameter together with year returns the last score generated for that specific year/month period. If year and month are not supplied, the API defaults to the current month and returns the score generated in the current month.

Required range: 1 <= x <= 12
Example:

3

Response

200 - application/json; charset=utf-8

OK

status
string
message
string
data
Data · object
Example: