List audience grants

GET

https://api.sureshake.com/v2/reports/{id}/audience-grants

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- reportId
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- viewerGroupId
  string
  required
  format: uuid
- viewerGroupName
  string
  required
- membershipMode
  dynamic
  or
  snapshot
  required
- permission
  read
  required
- validFrom
  string
  required
  format: date-time
- validUntil
  string
  or null
  required
  format: date-time
- grantedByUserId
  string
  required
- revokedAt
  string
  or null
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- memberCount
  integer
  required
  minimum: 0
- active
  boolean
  required
- accessStatus
  ready
  or
  pending
  or
  unavailable
  or
  inactive
  required
- allowDownload
  optional
  boolean
  or null
- watermark
  optional
  boolean
  or null
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "viewerGroupId": "1288fc75-43e2-4c00-9b50-a958b9887867", "viewerGroupName": "string", "membershipMode": "dynamic", "permission": "read", "validFrom": "2019-08-24T14:15:22Z", "validUntil": "2019-08-24T14:15:22Z", "grantedByUserId": "string", "revokedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "memberCount": 0, "active": true, "accessStatus": "ready", "allowDownload": true, "watermark": true } ], "meta": { "timestamp": "2019-08-24T14:15:22Z" } }