fds.analyticsapi.engines.ColumnStatisticsApi

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

Method	HTTP request	Description
get_pa_column_statistics	GET /analytics/engines/pa/v3/columnstatistics	Get PA column statistics

get_pa_column_statistics

ColumnStatisticRoot get_pa_column_statistics()

Get PA column statistics

This endpoint lists all the column statistics that can be applied to a PA column.

Example

• Basic Authentication (Basic):
• Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import column_statistics_api from fds.analyticsapi.engines.model.column_statistic_root import ColumnStatisticRoot from pprint import pprint

  Defining the host is optional and defaults to https://api.factset.com

  See configuration.py for a list of all supported configuration parameters.

  configuration = fds.analyticsapi.engines.Configuration( host = “https://api.factset.com” )

The client must configure the authentication and authorization parameters

in accordance with the API server security policy.

Examples for each auth method are provided below, use the example that

satisfies your auth use case.

Configure HTTP basic authorization: Basic

configuration = fds.analyticsapi.engines.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )

Configure Bearer authorization: Bearer

configuration = fds.analyticsapi.engines.Configuration( access_token = ‘YOUR_BEARER_TOKEN’ )

Enter a context with an instance of the API client

with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = column_statistics_api.ColumnStatisticsApi(api_client)

# example, this endpoint has no required or optional parameters
try:
    # Get PA column statistics
    api_response = api_instance.get_pa_column_statistics()
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling ColumnStatisticsApi->get_pa_column_statistics: %s\n" % e) ```

Parameters

This endpoint does not need any parameter.

Return type

• A tuple with response data, HTTP status code and response headers.
• Response datatype: ColumnStatisticRoot

Authorization

Basic, Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response, returns a list of PA column statistics | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 401 | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| 403 | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 406 | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| 503 | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
|

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