klippa_ocr_api.InformationApi

All URIs are relative to https://custom-ocr.klippa.com/api/v1

Method	HTTP request	Description
credits	GET /credits	List available credits.
get_api_index	GET /	Information about the API.
get_fields	GET /fields	List of available fields.
get_fields_by_template	GET /fields/{Template}	List of available fields for a specific template.
get_templates	GET /templates	List of available templates.
list_statistics_input	GET /statistics	Get API usage statistics.

credits

GetCreditsBody credits()

List available credits.

Example

Api Key Authentication (APIKeyHeader):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    
    try:
        # List available credits.
        api_response = api_instance.credits()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->credits: %s\n" % e)

Api Key Authentication (APIKeyQueryParam):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    
    try:
        # List available credits.
        api_response = api_instance.credits()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->credits: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetCreditsBody

Authorization

APIKeyHeader, APIKeyQueryParam

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response with available credits.	-
500	The serializable Error structure. Used for any common errors.	-

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

get_api_index

APIIndexBody get_api_index()

Information about the API.

Example

Api Key Authentication (APIKeyHeader):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    
    try:
        # Information about the API.
        api_response = api_instance.get_api_index()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->get_api_index: %s\n" % e)

Api Key Authentication (APIKeyQueryParam):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    
    try:
        # Information about the API.
        api_response = api_instance.get_api_index()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->get_api_index: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

APIIndexBody

Authorization

APIKeyHeader, APIKeyQueryParam

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Information about the API.	-
500	The serializable Error structure. Used for any common errors.	-

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

get_fields

GetFieldsBody get_fields()

List of available fields.

Example

Api Key Authentication (APIKeyHeader):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    
    try:
        # List of available fields.
        api_response = api_instance.get_fields()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->get_fields: %s\n" % e)

Api Key Authentication (APIKeyQueryParam):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    
    try:
        # List of available fields.
        api_response = api_instance.get_fields()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->get_fields: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetFieldsBody

Authorization

APIKeyHeader, APIKeyQueryParam

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response with available fields.	-
500	The serializable Error structure. Used for any common errors.	-

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

get_fields_by_template

GetFieldsBody get_fields_by_template(template)

List of available fields for a specific template.

Example

Api Key Authentication (APIKeyHeader):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    template = 'template_example' # str | The key of the template.

    try:
        # List of available fields for a specific template.
        api_response = api_instance.get_fields_by_template(template)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->get_fields_by_template: %s\n" % e)

Api Key Authentication (APIKeyQueryParam):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    template = 'template_example' # str | The key of the template.

    try:
        # List of available fields for a specific template.
        api_response = api_instance.get_fields_by_template(template)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->get_fields_by_template: %s\n" % e)

Parameters

Name	Type	Description	Notes
template	str	The key of the template.

Return type

GetFieldsBody

Authorization

APIKeyHeader, APIKeyQueryParam

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response with available fields.	-
500	The serializable Error structure. Used for any common errors.	-

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

get_templates

GetTemplatesBody get_templates()

List of available templates.

Example

Api Key Authentication (APIKeyHeader):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    
    try:
        # List of available templates.
        api_response = api_instance.get_templates()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->get_templates: %s\n" % e)

Api Key Authentication (APIKeyQueryParam):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    
    try:
        # List of available templates.
        api_response = api_instance.get_templates()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->get_templates: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetTemplatesBody

Authorization

APIKeyHeader, APIKeyQueryParam

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response with available templates.	-
500	The serializable Error structure. Used for any common errors.	-

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

list_statistics_input

GetStatisticsBody list_statistics_input(date_min=date_min, date_max=date_max, granularity=granularity, public_key_id=public_key_id, public_key_external_id=public_key_external_id, include_sub_keys=include_sub_keys)

Get API usage statistics.

Example

Api Key Authentication (APIKeyHeader):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    date_min = '2013-10-20T19:20:30+01:00' # datetime | The minimum date of the receipts. (optional)
date_max = '2013-10-20T19:20:30+01:00' # datetime | The maximum date of the receipts. (optional)
granularity = 'day' # str | The granularity of the stat. (optional) (default to 'day')
public_key_id = 56 # int | The id of the public key. (optional)
public_key_external_id = 'public_key_external_id_example' # str | The external identifier of the public key. (optional)
include_sub_keys = '1' # str | Whether to include sub keys in the stats. (optional) (default to '1')

    try:
        # Get API usage statistics.
        api_response = api_instance.list_statistics_input(date_min=date_min, date_max=date_max, granularity=granularity, public_key_id=public_key_id, public_key_external_id=public_key_external_id, include_sub_keys=include_sub_keys)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->list_statistics_input: %s\n" % e)

Api Key Authentication (APIKeyQueryParam):

from __future__ import print_function
import time
import klippa_ocr_api
from klippa_ocr_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://custom-ocr.klippa.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1"
)

# 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 API key authorization: APIKeyHeader
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Configure API key authorization: APIKeyQueryParam
configuration = klippa_ocr_api.Configuration(
    host = "https://custom-ocr.klippa.com/api/v1",
    api_key = {
        'X-Auth-Key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with klippa_ocr_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = klippa_ocr_api.InformationApi(api_client)
    date_min = '2013-10-20T19:20:30+01:00' # datetime | The minimum date of the receipts. (optional)
date_max = '2013-10-20T19:20:30+01:00' # datetime | The maximum date of the receipts. (optional)
granularity = 'day' # str | The granularity of the stat. (optional) (default to 'day')
public_key_id = 56 # int | The id of the public key. (optional)
public_key_external_id = 'public_key_external_id_example' # str | The external identifier of the public key. (optional)
include_sub_keys = '1' # str | Whether to include sub keys in the stats. (optional) (default to '1')

    try:
        # Get API usage statistics.
        api_response = api_instance.list_statistics_input(date_min=date_min, date_max=date_max, granularity=granularity, public_key_id=public_key_id, public_key_external_id=public_key_external_id, include_sub_keys=include_sub_keys)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling InformationApi->list_statistics_input: %s\n" % e)

Parameters

Name	Type	Description	Notes
date_min	datetime	The minimum date of the receipts.	[optional]
date_max	datetime	The maximum date of the receipts.	[optional]
granularity	str	The granularity of the stat.	[optional] [default to 'day']
public_key_id	int	The id of the public key.	[optional]
public_key_external_id	str	The external identifier of the public key.	[optional]
include_sub_keys	str	Whether to include sub keys in the stats.	[optional] [default to '1']

Return type

GetStatisticsBody

Authorization

APIKeyHeader, APIKeyQueryParam

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response with statistics of the API usage.	-
500	The serializable Error structure. Used for any common errors.	-

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

FilesExpand file tree

InformationApi.md

Latest commit

History

InformationApi.md

File metadata and controls

klippa_ocr_api.InformationApi

credits

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_api_index

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_fields

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_fields_by_template

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_templates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_statistics_input

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details