GETADITUS/Byndr/Connections/Get daily quota

Get daily quota

GET{{API_BASE_URL}}/byndr/v1/users/:initiatorUserd/connections/quota/:event

Get daily quota

This endpoint retrieves the daily connection quota for a specific user. It provides information about the number of connections made by the user on the current day, as well as the limit on the number of connections that can be made in a day.

Request

  • Method: GET

  • URL: {{API_BASE_URL}}/byndr/v1/users/:initiatorUserId/connections/quota/:event

Path Parameters

  • INITIATOR_USER_ID (string): The unique identifier of the user for whom the daily connection statistics are being requested.

  • EVENT (string): A parameter representing the event for which the quota is being requested.

Response

The response is a JSON object containing the following structure:

  • data (object): An object that holds the connection statistics.

    • initiatorUserId (string): The ID of the user for whom the statistics are reported.

    • made (integer): The number of connections made by the user.

    • limit (integer): The maximum number of connections that the user is allowed to make
      (Negative amounts represent no limit)

    • left (integer): The number of connections remaining for the user.
      (Negative amounts represent no limit)

Example Response

{
"data": {
"initiatorUserId": "",
"made": 0,
"limit": 0,
"left": 0
}
}

This endpoint is useful for monitoring user engagement and ensuring that users adhere to connection limits.

Authentication#auth

This endpoint does not require authentication.

Responses#responses

200OKget daily quota