Page through taps

GET

/api/v1/cards/taps

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

A page of taps on the workspace’s review cards over the last 90 days, or one card’s (cardId), the newest first, each with its rating and how far it got. Read from the tap log, which fills in a few minutes after a tap. Pass nextCursor back as cursor for the next page.

Needs the reviews:read permission.

Authorizations

apiKey
bearer

Parameters

Query Parameters

cardId

string

/^card_[0-9A-HJKMNP-TV-Z]{26}$/

cursor

The nextCursor of the page before. Leave it out for the first page.

string

<= 400 characters

The nextCursor of the page before. Leave it out for the first page.

limit

Rows on the page: 50 unless it says, 100 at most.

integer

>= 1 <= 100

Rows on the page: 50 unless it says, 100 at most.

Responses

200

Done

application/json

object

rows

required

Array<object>

object

required

string

cardId

required

string

required

string format: date-time

rating

required

number | null

outcome

required

string

Allowed values: google feedback rated left

device

required

string

Allowed values: iPhone Android Other

via

required

string

Allowed values: nfc qr

nextCursor

required

Pass it as cursor for the next page; null on the last.

string | null

Example

{
  "rows": [
    {
      "outcome": "google",
      "device": "iPhone",
      "via": "nfc"
    }
  ]
}

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