Skip to content
digizeDocs

List reviews

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

Every review from Google, Facebook and the workspace’s sites, the newest first, with the team’s replies and whether the site widget shows each.

Needs the reviews:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
rows
required
Array<object>
object
id
required
string
source
required
string
Allowed values: google facebook site
rating
required
integer
>= 1 <= 5
title
required

Site reviews have one.

string | null
body
required
string
reviewer
required
object
id
required

The contact, when it matches one.

string | null
name
required
string
photoUrl
required
string | null
subject
required

The product a site review is about.

string | null
createdAt
required
string format: date-time
reply
required
Any of:
object
body
required
string
author
required
string
at
required
string format: date-time
state
required

Whether it’s on the review site yet.

string
Allowed values: posted sending failed
error
required
string | null
shownOnSite
required

Whether the site widget shows it.

boolean
pending
required

A site review nobody has approved or hidden yet.

boolean
requestId
required
string | null
total
required
number

Example 

{
  "rows": [
    {
      "source": "google",
      "reply": {
        "state": "posted"
      }
    }
  ]
}

400

Section titled “400”

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

401

Section titled “401”

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

403

Section titled “403”

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

404

Section titled “404”

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

429

Section titled “429”

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