Skip to content

List Google posts

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

Updates, offers and events on the Google Business Profile: drafts, then scheduled ones, then the rest, newest first.

Needs the reviews:read permission.

Done

Media typeapplication/json
object
rows
required
Array<object>
object
id
required
string
type
required
string
Allowed values: update offer event
status
required
string
Allowed values: live scheduled draft expired rejected
title
required
string | null
body
required
string
media
required
Array<object>
object
id
required
string
<= 64 characters
kind
required
string
Allowed values: photo video
fileName
required
string
<= 200 characters
description
required
string
<= 750 characters
imageId
required
Any of:
string
<= 200 characters
videoKey
required
Any of:
string
<= 400 characters
previewUrl
required
string | null
button
required
Any of:
object
action
required
string
Allowed values: book order shop learn_more sign_up call
url
required
Any of:
string
<= 500 characters
startsAt
required
Any of:
string format: date-time
endsAt
required
Any of:
string format: date-time
offer
required
Any of:
object
couponCode
required
string
<= 60 characters
terms
required
string
<= 5000 characters
redeemUrl
required
string
<= 500 characters
publishAt
required
Any of:
string format: date-time
author
required
string
createdAt
required
string format: date-time
views
required
number
clicks
required
number
rejection
required
string | null
pushState
required
Any of:
string
Allowed values: sending failed
searchUrl
required
string | null
total
required
number

Example

{
"rows": [
{
"type": "update",
"status": "live",
"media": [
{
"kind": "photo"
}
],
"button": {
"action": "book"
},
"pushState": "sending"
}
]
}

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"
}
}