Atoka API User Reference

v20240416.0917

CIGS Search

This API allows you to search for CIGS measures.

https://api.atoka.io/v2/cigs

All requests must be properly authenticated.

Authentication

Parameters

  • token string required

    All requests must be properly authenticated; see the Authentication section for more info

curl -G "https://api.atoka.io/v2/cigs"

Response

By default this API endpoint returns the list of CIGS measures matching the selected criteria.

Using these parameters, you'll be able to customize the output you'll get from your searches.

Parameters

  • fields array,
    default is items

    Get just the list of CIGS measures matched, or the search facets (or both!).

    If you set this to value none, you'll get just the meta object, with count of notes to accounts matching your search criteria.

    Accepts multiple values, separated with , (comma) char: will match on any value (logic OR).

    Possible values are:

    • items
    • none
curl -G "https://api.atoka.io/v2/cigs" -d "fields=items"

Response modifications

When fields is items, the response will be:

{
"items": [
{
"id": "foo",
"decreeDate": "2015-12-24"
},
...
],
"meta": {
"ordering": "default",
"count": 57,
"limit": 10,
"offset": 30,
"info": [
"foo",
...
],
"obfuscated": {
"foo": undefined,
"bar": undefined,
"baz": undefined
}
}
}
curl -G "https://api.atoka.io/v2/cigs" -d "fields=items"

Data packages

This parameter is left for future, as currently only one package is available for CIGS measures. In the future you will be able to fine tune the fields you want to be returned by the API, similarly to what is done in the other Atoka APIs.

If you have special needs and want to further customize the data returned, we can adapt the output to your specific needs: just get in touch with us at sales@atoka.io.

Parameters

  • packages array

    Fine tune the results to the level of detail your application actually requires.

    The extraction cost per single item will be multiplied to the number of results in your query (up to offset parameter value).

    To avoid using any package, don't pass this parameter and the results will contain just the Atoka CIGS ID (and little more).

    Accepts multiple values, separated with , (comma) char: will match on any value (logic OR).

    Possible values are:

    • base
    • * (use all the data packages you have an active subscription for)
curl -G "https://api.atoka.io/v2/cigs" -d "packages=*"

Response modifications

When packages is *, the response will be:

{
"items": [
{
"id": "foo",
"decreeDate": "2015-12-24",
},
...
],
"facets": {
},
"queryExplanation": [
{
"engine": "foo",
"text": "foo",
"json": {"foo": "bar"}
},
...
],
"meta": {
"ordering": "default",
"count": 57,
"limit": 10,
"offset": 30,
"info": [
"foo",
...
],
"obfuscated": {
"foo": undefined,
"bar": undefined,
"baz": undefined
}
}
}
curl -G "https://api.atoka.io/v2/cigs" -d "packages=*"

Ordering & Pagination

To download long lists of results you can paginate returned items using these parameters.

You can also decide the order in which items are returned.

Parameters

  • limit integer,
    default is 10

    This is the number of individual objects that are returned in each page.

    Use a number between 0 and 50.

  • offset integer,
    default is 0

    This offsets the start of each page by the number specified.

    Use a number between 0 and 9950.

  • ordering string,
    default is "decreeDateDesc"

    Selects the order in which results are returned.

    Choose only one among:

    • id
    • decreeDate
    • decreeDateDesc
curl -G "https://api.atoka.io/v2/cigs" -d "limit=10" -d "offset=30" -d "ordering=decreeDateDesc"

General info

These filters act on the general information of the CIGS measures

Parameters

  • companies array base

    Search via already known Company ID.

    Accepts multiple values, separated with , (comma) char.

curl -G "https://api.atoka.io/v2/cigs"

Debug

Use these parameters when you need to understand how your request was evaluated by the API.

Parameters

  • explain boolean,
    default is false

    When using this parameter in your request you'll get and additional property in the results explanation, that contains all the filters actually used during the query.

    Mostly useful for debugging purposes.

curl -G "https://api.atoka.io/v2/cigs" -d "explain=true"

Response modifications

When explain is true, the response will be:

curl -G "https://api.atoka.io/v2/cigs" -d "explain=true"

Response

The list for CIGS measures

{
"items": [
{
"id": "foo",
"decreeDate": "2015-12-24",
},
...
],
"facets": {
},
"queryExplanation": [
{
"engine": "foo",
"text": "foo",
"json": {"foo": "bar"}
},
...
],
"meta": {
"ordering": "default",
"count": 57,
"limit": 10,
"offset": 30,
"info": [
"foo",
...
],
"obfuscated": {
"foo": undefined,
"bar": undefined,
"baz": undefined
}
}
}

CIGS Measure Details

Show full details of a CIGS measure.

By default we show all information available using all the data packages you subscribed to. Use the package parameter to fine tune the output format.

If you have special needs and want to further customize the data returned, we can adapt the output to your specific needs: just get in touch with us at sales@atoka.io.

https://api.atoka.io/v2/cigs/{id}

Replace {id} with the Atoka CIGS measure ID you want details for (as returned by the [CIGS Search](#cigs)..

All requests must be properly authenticated.

Data Packages

This parameter is left for future, as currently only one package is available for CIGS measures. In the future you will be able to fine tune the fields you want to be returned by the API, similarly to what is done in the other Atoka APIs.

Remember: your subscription gives you access to different levels of detail in data returned!

Parameters

  • packages array,
    default is *

    By using this parameter you can fine tune the results to the level of detail your application actually requires.

    Accepts multiple values, separated with , (comma) char: will match on any value (logic OR).

    Possible values are:

    • base
    • * use all the data packages you have an active subscription for
curl -G "https://api.atoka.io/v2/cigs/{id}" -d "packages=*"

Response modifications

When packages is *, the response will be:

{
"item": {
"id": "foo",
"decreeDate": "2015-12-24",
},
"queryExplanation": [
{
"engine": "foo",
"text": "foo",
"json": {"foo": "bar"}
},
...
]
}
curl -G "https://api.atoka.io/v2/cigs/{id}" -d "packages=*"

Debug

Use these parameters when you need to understand how your request was evaluated by the API.

Parameters

  • explain boolean,
    default is false

    When using this parameter in your request you'll get and additional property in the results explanation, that contains all the filters actually used during the query.

    Mostly useful for debugging purposes.

curl -G "https://api.atoka.io/v2/cigs/{id}" -d "explain=true"

Response modifications

When explain is true, the response will be:

curl -G "https://api.atoka.io/v2/cigs/{id}" -d "explain=true"

Response

Through the autentication credentials (the token) you are given, we are able to adapt the data available in API responses to your specific needs.

Moreover, depending on your subscription plan, you'll be able to retrieve different levels of details from the API calls.

{
"item": {
"id": "foo",
"decreeDate": "2015-12-24",
},
"queryExplanation": [
{
"engine": "foo",
"text": "foo",
"json": {"foo": "bar"}
},
...
]
}