Review stats

GET

/api/v1/reviews/stats

const url = 'https://digize.com/api/v1/reviews/stats';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

The average rating and how ratings spread, by source, with the last 30 days’ new reviews and reply rate against the 30 before.

Needs the reviews:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

average

required

number

count

required

number

distribution

required

Array<object>

object

rating

required

number

count

required

number

sources

required

Array<object>

object

source

required

string

Allowed values: google facebook site

count

required

number

average

required

number

newReviews

required

object

value

required

number

change

required

Percent against the period before.

number

trend

required

Array<number>

replyRate

required

The share of reviews with a reply, 0 to 1.

object

value

required

number

change

required

Percent against the period before.

number

trend

required

Array<number>

shownOnSite

required

number

Example

{
  "sources": [
    {
      "source": "google"
    }
  ]
}

400

What was sent isn’t valid (invalid).

application/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

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

application/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

The key doesn’t have the permission this needs.

application/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

Nothing has that id (not_found).

application/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

Over the rate limit; see retry-after.

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