Skip to content

Latest commit

 

History

History
114 lines (86 loc) · 5.16 KB

EventsApi.md

File metadata and controls

114 lines (86 loc) · 5.16 KB
Raw

Fastly\Api\EventsApi

$apiInstance = new Fastly\Api\EventsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

Methods

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
getEvent() GET /events/{event_id} Get an event
listEvents() GET /events List events

getEvent()

getEvent($options): \Fastly\Model\EventResponse // Get an event

Get a specific event.

Example

    $options['event_id'] = 'event_id_example'; // string | Alphanumeric string identifying an event.

try {
    $result = $apiInstance->getEvent($options);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getEvent: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
event_id string Alphanumeric string identifying an event.

Return type

\Fastly\Model\EventResponse

[Back to top] [Back to API list] [Back to README]

listEvents()

listEvents($options): \Fastly\Model\EventsResponse // List events

List all events for a particular customer. Events can be filtered by user, customer and event type. Events can be sorted by date.

Example

    $options['filter_customer_id'] = x4xCwxxJxGCx123Rx5xTx; // string | Limit the results returned to a specific customer.
$options['filter_event_type'] = 'filter_event_type_example'; // string | Limit the returned events to a specific `event_type`.
$options['filter_service_id'] = 'filter_service_id_example'; // string | Limit the results returned to a specific service.
$options['filter_user_id'] = 'filter_user_id_example'; // string | Limit the results returned to a specific user.
$options['filter_token_id'] = 'filter_token_id_example'; // string | Limit the returned events to a specific token.
$options['filter_created_at'] = 'filter_created_at_example'; // string | Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12).
$options['filter_created_at_lte'] = 'filter_created_at_lte_example'; // string | Return events on and before a date and time in ISO 8601 format.
$options['filter_created_at_lt'] = 'filter_created_at_lt_example'; // string | Return events before a date and time in ISO 8601 format.
$options['filter_created_at_gte'] = 'filter_created_at_gte_example'; // string | Return events on and after a date and time in ISO 8601 format.
$options['filter_created_at_gt'] = 'filter_created_at_gt_example'; // string | Return events after a date and time in ISO 8601 format.
$options['page_number'] = 1; // int | Current page.
$options['page_size'] = 20; // int | Number of records per page.
$options['sort'] = created_at; // string | The order in which to list the results by creation date.

try {
    $result = $apiInstance->listEvents($options);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->listEvents: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
filter_customer_id string Limit the results returned to a specific customer. [optional]
filter_event_type string Limit the returned events to a specific event_type. [optional]
filter_service_id string Limit the results returned to a specific service. [optional]
filter_user_id string Limit the results returned to a specific user. [optional]
filter_token_id string Limit the returned events to a specific token. [optional]
filter_created_at string Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12). [optional]
filter_created_at_lte string Return events on and before a date and time in ISO 8601 format. [optional]
filter_created_at_lt string Return events before a date and time in ISO 8601 format. [optional]
filter_created_at_gte string Return events on and after a date and time in ISO 8601 format. [optional]
filter_created_at_gt string Return events after a date and time in ISO 8601 format. [optional]
page_number int Current page. [optional]
page_size int Number of records per page. [optional] [defaults to 20]
sort string The order in which to list the results by creation date. [optional] [one of: 'created_at', '-created_at'] [defaults to 'created_at']

Return type

\Fastly\Model\EventsResponse

[Back to top] [Back to API list] [Back to README]