Skip to content

README.md

Latest commit

 

History

History
60 lines (40 loc) · 4.21 KB

README.md

File metadata and controls

60 lines (40 loc) · 4.21 KB

ConsumerRequestCounts

(vault.consumer_request_counts)

Overview

Available Operations

  • list - Consumer request counts

list

Get consumer request counts within a given datetime range.

Example Usage

from apideck_unify import Apideck
import os


with Apideck(
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.vault.consumer_request_counts.list(consumer_id="test_user_id", start_datetime="2021-05-01T12:00:00.000Z", end_datetime="2021-05-30T12:00:00.000Z")

    assert res.consumer_request_counts_in_date_range_response is not None

    # Handle response
    print(res.consumer_request_counts_in_date_range_response)

Parameters

Parameter Type Required Description Example
consumer_id str ✔️ ID of the consumer to return test_user_id
start_datetime str ✔️ Scopes results to requests that happened after datetime 2021-05-01T12:00:00.000Z
end_datetime str ✔️ Scopes results to requests that happened before datetime 2021-05-30T12:00:00.000Z
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.VaultConsumerRequestCountsAllResponse

Errors

Error Type Status Code Content Type
models.BadRequestResponse 400 application/json
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.NotFoundResponse 404 application/json
models.UnprocessableResponse 422 application/json
models.APIError 4XX, 5XX */*