ApiRequestsApi
ApiRequestsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getOrganizationApiRequests() : object
- Operation getOrganizationApiRequests
- getOrganizationApiRequestsAsync() : PromiseInterface
- Operation getOrganizationApiRequestsAsync
- getOrganizationApiRequestsAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationApiRequestsAsyncWithHttpInfo
- getOrganizationApiRequestsOverview() : object
- Operation getOrganizationApiRequestsOverview
- getOrganizationApiRequestsOverviewAsync() : PromiseInterface
- Operation getOrganizationApiRequestsOverviewAsync
- getOrganizationApiRequestsOverviewAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationApiRequestsOverviewAsyncWithHttpInfo
- getOrganizationApiRequestsOverviewWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationApiRequestsOverviewWithHttpInfo
- getOrganizationApiRequestsWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationApiRequestsWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getOrganizationApiRequestsOverviewRequest() : Request
- Create request for operation 'getOrganizationApiRequestsOverview'
- getOrganizationApiRequestsRequest() : Request
- Create request for operation 'getOrganizationApiRequests'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getOrganizationApiRequests()
Operation getOrganizationApiRequests
public
getOrganizationApiRequests(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : object
List the API requests made by an organization
Parameters
- $organization_id : string
-
organization_id (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $admin_id : string = null
-
Filter the results by the ID of the admin who made the API requests (optional)
- $path : string = null
-
Filter the results by the path of the API requests (optional)
- $method : string = null
-
Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
- $response_code : int = null
-
Filter the results by the response code of the API requests (optional)
- $source_ip : string = null
-
Filter the results by the IP address of the originating API request (optional)
Tags
Return values
object —getOrganizationApiRequestsAsync()
Operation getOrganizationApiRequestsAsync
public
getOrganizationApiRequestsAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : PromiseInterface
List the API requests made by an organization
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $admin_id : string = null
-
Filter the results by the ID of the admin who made the API requests (optional)
- $path : string = null
-
Filter the results by the path of the API requests (optional)
- $method : string = null
-
Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
- $response_code : int = null
-
Filter the results by the response code of the API requests (optional)
- $source_ip : string = null
-
Filter the results by the IP address of the originating API request (optional)
Tags
Return values
PromiseInterface —getOrganizationApiRequestsAsyncWithHttpInfo()
Operation getOrganizationApiRequestsAsyncWithHttpInfo
public
getOrganizationApiRequestsAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : PromiseInterface
List the API requests made by an organization
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $admin_id : string = null
-
Filter the results by the ID of the admin who made the API requests (optional)
- $path : string = null
-
Filter the results by the path of the API requests (optional)
- $method : string = null
-
Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
- $response_code : int = null
-
Filter the results by the response code of the API requests (optional)
- $source_ip : string = null
-
Filter the results by the IP address of the originating API request (optional)
Tags
Return values
PromiseInterface —getOrganizationApiRequestsOverview()
Operation getOrganizationApiRequestsOverview
public
getOrganizationApiRequestsOverview(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object
Return an aggregated overview of API requests data
Parameters
- $organization_id : string
-
organization_id (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
Tags
Return values
object —getOrganizationApiRequestsOverviewAsync()
Operation getOrganizationApiRequestsOverviewAsync
public
getOrganizationApiRequestsOverviewAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface
Return an aggregated overview of API requests data
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
Tags
Return values
PromiseInterface —getOrganizationApiRequestsOverviewAsyncWithHttpInfo()
Operation getOrganizationApiRequestsOverviewAsyncWithHttpInfo
public
getOrganizationApiRequestsOverviewAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface
Return an aggregated overview of API requests data
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
Tags
Return values
PromiseInterface —getOrganizationApiRequestsOverviewWithHttpInfo()
Operation getOrganizationApiRequestsOverviewWithHttpInfo
public
getOrganizationApiRequestsOverviewWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>
Return an aggregated overview of API requests data
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationApiRequestsWithHttpInfo()
Operation getOrganizationApiRequestsWithHttpInfo
public
getOrganizationApiRequestsWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : array<string|int, mixed>
List the API requests made by an organization
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $admin_id : string = null
-
Filter the results by the ID of the admin who made the API requests (optional)
- $path : string = null
-
Filter the results by the path of the API requests (optional)
- $method : string = null
-
Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
- $response_code : int = null
-
Filter the results by the response code of the API requests (optional)
- $source_ip : string = null
-
Filter the results by the IP address of the originating API request (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
getOrganizationApiRequestsOverviewRequest()
Create request for operation 'getOrganizationApiRequestsOverview'
protected
getOrganizationApiRequestsOverviewRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
Tags
Return values
Request —getOrganizationApiRequestsRequest()
Create request for operation 'getOrganizationApiRequests'
protected
getOrganizationApiRequestsRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $admin_id : string = null
-
Filter the results by the ID of the admin who made the API requests (optional)
- $path : string = null
-
Filter the results by the path of the API requests (optional)
- $method : string = null
-
Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
- $response_code : int = null
-
Filter the results by the response code of the API requests (optional)
- $source_ip : string = null
-
Filter the results by the IP address of the originating API request (optional)