flywheel.api.reports_api
ReportsApi
Bases: object
collect_usage(**kwargs)
Collect daily usage statistics.
Collects usage statistics for the selected day (or yesterday if no day is given) This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
year | (int, optional) | The year portion of the date | required |
month | (int, optional) | The month portion of the date | required |
day | (int, optional) | The day portion of the date | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
collect_usage_with_http_info(**kwargs)
Collect daily usage statistics.
Collects usage statistics for the selected day (or yesterday if no day is given) This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
year | (int, optional) | The year portion of the date | required |
month | (int, optional) | The month portion of the date | required |
day | (int, optional) | The day portion of the date | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_access_log_report(**kwargs)
Get a report of access log entries for the given parameters
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
csv | (bool, optional) | Set to download a csv file instead of json, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return, defaults to 100 | required |
skip | (int, optional) | The number of entries to skip | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
start_date | (datetime, optional) | An ISO formatted timestamp for the start time of the report | required |
end_date | (datetime, optional) | An ISO formatted timestamp for the end time of the report | required |
user | (str, optional) | User id of the target user | required |
subject | (str, optional) | Limit the report to the subject code of subject accessed | required |
project | (str, optional) | Limit the report to the project id | required |
access_types | (list[AccessType], optional) | The list of access_types to filter logs | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_access_log_report_with_http_info(**kwargs)
Get a report of access log entries for the given parameters
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
csv | (bool, optional) | Set to download a csv file instead of json, defaults to false | required |
filter | (str, optional) | Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22) | required |
sort | (str, optional) | The sort fields and order.(e.g. label:asc,created:desc) | required |
limit | (int, optional) | The maximum number of entries to return, defaults to 100 | required |
skip | (int, optional) | The number of entries to skip | required |
page | (int, optional) | The page number (i.e. skip limit*page entries) | required |
after_id | (str, optional) | Paginate after the given id. (Cannot be used with sort, page or skip) | required |
start_date | (datetime, optional) | An ISO formatted timestamp for the start time of the report | required |
end_date | (datetime, optional) | An ISO formatted timestamp for the end time of the report | required |
user | (str, optional) | User id of the target user | required |
subject | (str, optional) | Limit the report to the subject code of subject accessed | required |
project | (str, optional) | Limit the report to the project id | required |
access_types | (list[AccessType], optional) | The list of access_types to filter logs | required |
x_accept_feature | (list[str], optional) | , defaults to [] | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_access_log_types(**kwargs)
Get the list of types of access log entries
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_access_log_types_with_http_info(**kwargs)
Get the list of types of access log entries
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_daily_usage_range_report(**kwargs)
DEPRECATED - Use /reports/usage-summary instead
This report is DEPRECATED and will be removed in release 23.0. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start_date | (datetime, optional) | An ISO formatted timestamp for the start time of the report | required |
end_date | (datetime, optional) | An ISO formatted timestamp for the end time of the report | required |
group | (str, optional) | Limit the report to the given group id | required |
project | (str, optional) | Limit the report to the given project id | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_daily_usage_range_report_with_http_info(**kwargs)
DEPRECATED - Use /reports/usage-summary instead
This report is DEPRECATED and will be removed in release 23.0. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start_date | (datetime, optional) | An ISO formatted timestamp for the start time of the report | required |
end_date | (datetime, optional) | An ISO formatted timestamp for the end time of the report | required |
group | (str, optional) | Limit the report to the given group id | required |
project | (str, optional) | Limit the report to the given project id | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_daily_usage_report(**kwargs)
Get a daily usage report for the given month.
If no year/month pair is given, the current month will be used. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
year | (int, optional) | The year portion of the date | required |
month | (int, optional) | The month portion of the date | required |
group | (str, optional) | Limit the report to the given group id | required |
project | (str, optional) | Limit the report to the given project id | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_daily_usage_report_with_http_info(**kwargs)
Get a daily usage report for the given month.
If no year/month pair is given, the current month will be used. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
year | (int, optional) | The year portion of the date | required |
month | (int, optional) | The month portion of the date | required |
group | (str, optional) | Limit the report to the given group id | required |
project | (str, optional) | Limit the report to the given project id | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_legacy_usage_report(type, **kwargs)
Get a usage report for the site grouped by month or project
This report is DEPRECATED and will be removed in release 23.0. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type | str | The type of usage report to generate | required |
start_date | (datetime, optional) | An ISO formatted timestamp for the start time of the report | required |
end_date | (datetime, optional) | An ISO formatted timestamp for the end time of the report | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_legacy_usage_report_with_http_info(type, **kwargs)
Get a usage report for the site grouped by month or project
This report is DEPRECATED and will be removed in release 23.0. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type | str | The type of usage report to generate | required |
start_date | (datetime, optional) | An ISO formatted timestamp for the start time of the report | required |
end_date | (datetime, optional) | An ISO formatted timestamp for the end time of the report | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_project_report(**kwargs)
Get project report
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
projects | (list[str], optional) | Specify multiple times to include projects in the report | required |
start_date | (datetime, optional) | An ISO formatted timestamp for the start time of the report | required |
end_date | (datetime, optional) | An ISO formatted timestamp for the end time of the report | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_project_report_with_http_info(**kwargs)
Get project report
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
projects | (list[str], optional) | Specify multiple times to include projects in the report | required |
start_date | (datetime, optional) | An ISO formatted timestamp for the start time of the report | required |
end_date | (datetime, optional) | An ISO formatted timestamp for the end time of the report | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_site_report(**kwargs)
Get the site report
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_site_report_with_http_info(**kwargs)
Get the site report
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_usage_availability(**kwargs)
Get year/month combinations where report data is available.
Get year/month combinations where report data is available. Returns: Returns the list of months where report data is available This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_usage_availability_with_http_info(**kwargs)
Get year/month combinations where report data is available.
Get year/month combinations where report data is available. Returns: Returns the list of months where report data is available This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
async_ | (bool, optional) | Perform the request asynchronously | required |
get_usage_data_summary(**kwargs)
Get aggregated usage data
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start_date | (date, optional) | | required |
end_date | (date, optional) | | required |
group | (str, optional) | | required |
project | (str, optional) | | required |
group_by | (str, optional) | If 'month', return data for each month, grouped over all projects. If 'group', return data for each group, grouped over all months (and projects within the group). If 'none' or 'project', return data for each project, grouped over all months., defaults to project | required |
limit | (int, optional) | | required |
skip | (int, optional) | | required |
sort | (str, optional) | Field to sort on, optionally followed by a direction, ':asc' or ':desc'. | required |
include_deleted_projects | (bool, optional) | , defaults to true | required |
lookback_window | (int, optional) | Number of days in the past within which usage data will be considered current, defaults to 2 | required |
csv | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_usage_data_summary_with_http_info(**kwargs)
Get aggregated usage data
This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
start_date | (date, optional) | | required |
end_date | (date, optional) | | required |
group | (str, optional) | | required |
project | (str, optional) | | required |
group_by | (str, optional) | If 'month', return data for each month, grouped over all projects. If 'group', return data for each group, grouped over all months (and projects within the group). If 'none' or 'project', return data for each project, grouped over all months., defaults to project | required |
limit | (int, optional) | | required |
skip | (int, optional) | | required |
sort | (str, optional) | Field to sort on, optionally followed by a direction, ':asc' or ':desc'. | required |
include_deleted_projects | (bool, optional) | , defaults to true | required |
lookback_window | (int, optional) | Number of days in the past within which usage data will be considered current, defaults to 2 | required |
csv | (str, optional) | | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_usage_report(**kwargs)
Get a usage report for the given month. If no year/month pair is given, the current month will be used.
This report is DEPRECATED and will be removed in a future release This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
year | (int, optional) | The year portion of the date | required |
month | (int, optional) | The month portion of the date | required |
project | (str, optional) | Project to filter to | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
get_usage_report_with_http_info(**kwargs)
Get a usage report for the given month. If no year/month pair is given, the current month will be used.
This report is DEPRECATED and will be removed in a future release This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
year | (int, optional) | The year portion of the date | required |
month | (int, optional) | The month portion of the date | required |
project | (str, optional) | Project to filter to | required |
async_ | (bool, optional) | Perform the request asynchronously | required |