Skip to main content
GET
/
business
/
search
/
stats
Get completion rate stats from your businesses
curl --request GET \
  --url https://api.partoo.co/v2/business/search/stats \
  --header 'x-APIKey: <api-key>'
{
  "average_completion_rate": 72,
  "counts": {
    "low": 2,
    "mid": 10,
    "high": 22
  }
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
query
string

Parameter to fuzzy search businesses on city, zipcode and name

​
business__in
string[]

Filter by business ids. Use a comma-separated list to provide multiple ids.

Example:

"a1c9f37b4deca92f83b61d02,9f4e2a8c0d73b154e621bc97,c73b15e9fa42d60b3a8c21ef"

​
org_id
integer

Filter by organization id

​
groups
integer[]

Filter by groups, using the access logic with the and/or depending on the groups sections

See the Groups and Sections description

​
country
string

Filter by country - ISO 3166 alpha2 code (i.e. “FR” for France)

​
name
string

Filter by name

​
status
enum<string>
default:open

Defines the current status of the business.

  • Open indicates the business is up and running.
  • Closed means that the business has definitely closed.
  • Opening Soon indicates the business is open with an opening date set in the future.
  • Temporarily closed means that the business is temporarily closed.

⚠️ To get all businesses with the status open, regardless of whether the opening_date has passed yet or not, submit both the open and opening_soon options in the filter: status=open,opening_soon.

Available options:
open,
closed,
opening_soon,
temporarily_closed
Example:

"open"

​
zipcode
string

Filter by zipcode

​
city
string

Filter by city

​
code
string

Filter by code

​
modified__gte
number

Filter by modified attribute (modified >= modified_gte)

​
features__in
enum<string>

Filter businesses that have all the features provided, separated by commas.

Available options:
diffusion,
feedback_management,
messages,
posts,
review_invite,
review_management
Example:

"diffusion,review_management"

​
features__notin
enum<string>

Filter businesses that do not have all the features provided, separated by commas.

Available options:
diffusion,
feedback_management,
messages,
posts,
review_invite,
review_management
Example:

"diffusion,review_management"

​
subscribed_to_rm
enum<string>

Filter by current subscription to review_management. Equivalent to using features__in=review_management.

Available options:
True,
False
​
subscribed_to_pm
enum<string>

Filter by current subscription to presence_management. Equivalent to using features__in=diffusion.

Available options:
True,
False
​
subscribed_to_rb
enum<string>

Filter by current subscription to review_booster. Equivalent to using features__in=review_invite.

Available options:
True,
False
​
subscribed_to_bm
enum<string>

Filter by current subscription to messages Equivalent to using features__in=messages

Available options:
True,
False
​
completion_rate__gte
number

Filter by completion_rate attribute (completion_rate >= completion_rate__gte)

​
completion_rate__lte
number

Filter by completion_rate attribute (completion_rate <= completion_rate__lte)

​
completion_rate
enum<string>

Filter by completion_rate attribute. You can separate the values by a comma, as done in the example.

Available options:
low,
mid,
high
Example:

"low,mid"

​
has_promo
enum<string>

Retrieve only businesses having promotional offers

Available options:
True,
False
​
connected_to_gmb_location
enum<string>

Filter by current link to a Google location

Available options:
True,
False
​
connected_to_facebook_location
enum<string>

Filter by current link to a Facebook location

Available options:
True,
False

Response

OK

​
average_completion_rate
integer

The average completion rate of all businesses that fit the filters given in paramers.

Example:

72

​
counts
object