List review requests

GET

/api/v1/reviews/requests

const url = 'https://digize.com/api/v1/reviews/requests';
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/requests \
  --header 'x-api-key: <x-api-key>'

Review requests from the last 60 days and the ones still to go out, with how far each got.

Needs the reviews:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

rows

required

Array<object>

object

required

string

number

required

number

contact

required

object

required

string

name

required

string

email

required

string

phone

required

string

channel

required

string

Allowed values: email sms

reason

required

string

Allowed values: order class manual

about

required

Order #1042, or the class’s name.

string

subject

required

string

destination

required

string

Allowed values: google site

status

required

string

Allowed values: scheduled sent opened clicked reviewed bounced cancelled

scheduledFor

required

string format: date-time

sentAt

required

Any of:

string
null

string format: date-time

openedAt

required

Any of:

string
null

string format: date-time

clickedAt

required

Any of:

string
null

string format: date-time

reviewedAt

required

Any of:

string
null

string format: date-time

review

required

Any of:

object
null

object

required

string

rating

required

number

body

required

string

message

required

string | null

error

required

Why it didn’t go out.

string | null

total

required

number

Example

{
  "rows": [
    {
      "channel": "email",
      "reason": "order",
      "destination": "google",
      "status": "scheduled"
    }
  ]
}

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