Skip to content

Profile views and searches

GET
/api/v1/reviews/profile/performance
curl --request GET \
--url https://digize.com/api/v1/reviews/profile/performance \
--header 'x-api-key: <x-api-key>'

The profile’s views and the actions people took from it each day for 180 days, and last month’s search terms.

Needs the reviews:read permission.

Done

Media typeapplication/json
object
days
required
Array<object>
object
date
required
string format: date-time
searchMobile
required
number
searchDesktop
required
number
mapsMobile
required
number
mapsDesktop
required
number
calls
required
number
websiteClicks
required
number
directions
required
number
bookings
required
number
menuClicks
required
number
termsMonth
required
string
searchTerms
required
Array<object>
object
term
required
string
searches
required
number | null
previous
required
number | null

Example generated

{
"days": [
{
"date": "2026-04-15T12:00:00Z",
"searchMobile": 1,
"searchDesktop": 1,
"mapsMobile": 1,
"mapsDesktop": 1,
"calls": 1,
"websiteClicks": 1,
"directions": 1,
"bookings": 1,
"menuClicks": 1
}
],
"termsMonth": "example",
"searchTerms": [
{
"term": "example",
"searches": 1,
"previous": 1
}
]
}

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example

{
"error": {
"code": "invalid"
}
}