Python 3: AI - Devolens (formerly Cryptolens) Documentation

Python 3 package licensing 0.54. Reviewed source revision.

from licensing.methods import AI

get_daily_aggregates

Read daily usage totals by product.

AI.get_daily_aggregates(
    token,
    product_id=0,
    limit=100,
    starting_after=0,
    ending_before=0,
    start='',
    end=''
)

Parameters

Parameter	Default	Meaning
`token`	Required	An access token with the Usage Analytics permission.
`product_id`	`0`	The numeric product ID.
`limit`	`100`	The maximum number of records to request in this page.
`starting_after`	`0`	The forward cursor from a previously returned record.
`ending_before`	`0`	The backward cursor from a previously returned record.
`start`	`''`	The first date to include, in `yyyy-MM-dd` format.
`end`	`''`	The last date to include, in `yyyy-MM-dd` format.

Result

Returns (items, ''), where items is the API’s aggregates list. Each item is a dictionary using the API’s camelCase field names. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

get_daily_country_aggregates

Read daily usage totals by product and country.

AI.get_daily_country_aggregates(
    token,
    product_id=0,
    country_code='',
    limit=100,
    starting_after=0,
    ending_before=0,
    start='',
    end=''
)

Parameters

Parameter	Default	Meaning
`token`	Required	An access token with the Usage Analytics permission.
`product_id`	`0`	The numeric product ID.
`country_code`	`''`	The country code to filter on, for example `SE`.
`limit`	`100`	The maximum number of records to request in this page.
`starting_after`	`0`	The forward cursor from a previously returned record.
`ending_before`	`0`	The backward cursor from a previously returned record.
`start`	`''`	The first date to include, in `yyyy-MM-dd` format.
`end`	`''`	The last date to include, in `yyyy-MM-dd` format.

Result

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

get_key_usage_summaries

Read usage summaries for license keys.

AI.get_key_usage_summaries(
    token,
    product_id=0,
    key_id=0,
    key='',
    limit=100,
    starting_after=0,
    ending_before=0,
    start='',
    end=''
)

Parameters

Parameter	Default	Meaning
`token`	Required	An access token with the Usage Analytics permission.
`product_id`	`0`	The numeric product ID.
`key_id`	`0`	The numeric license ID, rather than its license-key string.
`key`	`''`	The license-key string, rather than the numeric license ID.
`limit`	`100`	The maximum number of records to request in this page.
`starting_after`	`0`	The forward cursor from a previously returned record.
`ending_before`	`0`	The backward cursor from a previously returned record.
`start`	`''`	The first date to include, in `yyyy-MM-dd` format.
`end`	`''`	The last date to include, in `yyyy-MM-dd` format.

Result

Returns (items, ''), where items is the API’s summaries list. Each item is a dictionary using the API’s camelCase field names. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

get_key_devices

Read device usage associated with license keys.

AI.get_key_devices(
    token,
    product_id=0,
    key_id=0,
    key='',
    machine_code='',
    limit=100,
    starting_after=0,
    ending_before=0,
    start='',
    end=''
)

Parameters

Parameter	Default	Meaning
`token`	Required	An access token with the Usage Analytics permission.
`product_id`	`0`	The numeric product ID.
`key_id`	`0`	The numeric license ID, rather than its license-key string.
`key`	`''`	The license-key string, rather than the numeric license ID.
`machine_code`	`''`	The device or process identifier used for this activation. Reuse the same value when renewing or releasing it.
`limit`	`100`	The maximum number of records to request in this page.
`starting_after`	`0`	The forward cursor from a previously returned record.
`ending_before`	`0`	The backward cursor from a previously returned record.
`start`	`''`	The first date to include, in `yyyy-MM-dd` format.
`end`	`''`	The last date to include, in `yyyy-MM-dd` format.

Result

Returns (items, ''), where items is the API’s devices list. Each item is a dictionary using the API’s camelCase field names. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

get_license_activity_buckets

Read license activity grouped into time buckets.

AI.get_license_activity_buckets(
    token,
    product_id=0,
    key_id=0,
    key='',
    machine_code='',
    limit=100,
    starting_after=0,
    ending_before=0,
    start='',
    end=''
)

Parameters

Parameter	Default	Meaning
`token`	Required	An access token with the Usage Analytics permission.
`product_id`	`0`	The numeric product ID.
`key_id`	`0`	The numeric license ID, rather than its license-key string.
`key`	`''`	The license-key string, rather than the numeric license ID.
`machine_code`	`''`	The device or process identifier used for this activation. Reuse the same value when renewing or releasing it.
`limit`	`100`	The maximum number of records to request in this page.
`starting_after`	`0`	The forward cursor from a previously returned record.
`ending_before`	`0`	The backward cursor from a previously returned record.
`start`	`''`	The first date to include, in `yyyy-MM-dd` format.
`end`	`''`	The last date to include, in `yyyy-MM-dd` format.

Result

Returns (items, ''), where items is the API’s buckets list. Each item is a dictionary using the API’s camelCase field names. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

get_web_api_log

Retrieve Web API log records matching the supplied filters.

AI.get_web_api_log(
    token,
    product_id=0,
    key='',
    machine_code='',
    friendly_name='',
    limit=10,
    starting_after=0,
    ending_before=0,
    order_by=''
)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	`0`	The numeric product ID.
`key`	`''`	The license-key string, rather than the numeric license ID.
`machine_code`	`''`	The device or process identifier used for this activation. Reuse the same value when renewing or releasing it.
`friendly_name`	`''`	A display name for the activation. It does not replace the machine code.
`limit`	`10`	The maximum number of records to request in this page.
`starting_after`	`0`	The forward cursor from a previously returned record.
`ending_before`	`0`	The backward cursor from a previously returned record.
`order_by`	`''`	The API’s ordering expression.

Result

Returns (logs, ''), where logs is a list of API dictionaries. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

get_events

Retrieve registered application events.

AI.get_events(token, limit=10, starting_after=0, product_id=0, key='', metadata='')

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`limit`	`10`	The maximum number of records to request in this page.
`starting_after`	`0`	The forward cursor from a previously returned record.
`product_id`	`0`	The numeric product ID.
`key`	`''`	The license-key string, rather than the numeric license ID.
`metadata`	`''`	Accepted by this SDK signature, but not sent to the API in version 0.54. It does not change the request.

Result

Returns (events, ''), where events is a list of API dictionaries. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

register_event

Record an application event, such as a feature being used.

AI.register_event(
    token,
    product_id=0,
    key='',
    machine_code='',
    feature_name='',
    event_name='',
    value=0,
    currency='',
    metadata=''
)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`product_id`	`0`	The numeric product ID.
`key`	`''`	The license-key string, rather than the numeric license ID.
`machine_code`	`''`	The device or process identifier used for this activation. Reuse the same value when renewing or releasing it.
`feature_name`	`''`	The name of the feature associated with this event.
`event_name`	`''`	The name of the event being recorded.
`value`	`0`	The numeric value associated with the event.
`currency`	`''`	The ISO currency code, for example `USD`.
`metadata`	`''`	Additional event metadata passed to the API.

Result

Returns (True, message) on success. Returns (False, message) for API rejection and (None, message) for a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference. Python SDK Reference

​get_daily_aggregates

​Parameters

​Result

​Checks

​get_daily_country_aggregates

​Parameters

​Result

​Checks

​get_key_usage_summaries

​Parameters

​Result

​Checks

​get_key_devices

​Parameters

​Result

​Checks

​get_license_activity_buckets

​Parameters

​Result

​Checks

​get_web_api_log

​Parameters

​Result

​Checks

​get_events

​Parameters

​Result

​Checks

​register_event

​Parameters

​Result

​Checks

get_daily_aggregates

Parameters

Result

Checks

get_daily_country_aggregates

Parameters

Result

Checks

get_key_usage_summaries

Parameters

Result

Checks

get_key_devices

Parameters

Result

Checks

get_license_activity_buckets

Parameters

Result

Checks

get_web_api_log

Parameters

Result

Checks

get_events

Parameters

Result

Checks

register_event

Parameters

Result

Checks