Skip to content
digizeDocs

Review request stats

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

Requests sent, open rate, review rate and the rating they led to, the last 30 days against the 30 before.

Needs the reviews:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
sent
required
object
value
required
number
change
required

Percent against the period before.

number
trend
required
Array<number>
openRate
required
object
value
required
number
change
required

Percent against the period before.

number
trend
required
Array<number>
reviewRate
required
object
value
required
number
change
required

Percent against the period before.

number
trend
required
Array<number>
averageRating
required
object
value
required
number
change
required

Percent against the period before.

number
trend
required
Array<number>

Example generated

{
  "sent": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "openRate": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "reviewRate": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "averageRating": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  }
}

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