Atoka API User Reference

v20230601.1436

Feedback API

With this API you can notify us about wrong data. Mistakes can happen, and we want to allow users to give feedback about what's wrong, so that we can intervene (manually, for now) on the data.

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

All requests must be properly authenticated.

response

Parameters

  • token string required

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

curl -XPOST "https://api.atoka.io/v2/feedback"

General info

These are the parameters to submit a feedback. Not all of them are required, but the more you provide, the quicker we can start investigating and eventually fix the problem.

Parameters

  • item string required

    the atoka ID of the item (company, person, ...) the feedback is about

  • collection string required

    the collection of the item

    Choose only one among:

    • company
    • person
    • location
    • contract

  • field string required

    the field containing the error, as returned from the API

    Choose only one among:

    • arval.cluster
    • arval.cluster.code
    • arval.cluster.description
    • arval.paSubCluster
    • arval.paSubCluster.code
    • arval.paSubCluster.description
    • arval.paType
    • atokaIndicators.innovation
    • atokaIndicators.innovation.categoryScore
    • atokaIndicators.innovation.categoryScoreLabel
    • atokaIndicators.innovation.score
    • atokaIndicators.innovation.scoreLabel
    • atokaIndicators.innovation.updateTime
    • atokaIndicators.reliabilityScore
    • atokaIndicators.reliabilityScore.class
    • atokaIndicators.reliabilityScore.classLabel
    • atokaIndicators.reliabilityScore.updated
    • atokaIndicators.territorialScores
    • atokaIndicators.territorialScores.IDE
    • atokaIndicators.territorialScores.IDS
    • balanceSheets.items
    • balanceSheets.items.consolidated
    • balanceSheets.items.currency
    • balanceSheets.items.currency.code
    • balanceSheets.items.currency.symbol
    • balanceSheets.items.date
    • balanceSheets.items.division
    • balanceSheets.items.sections
    • balanceSheets.items.sections.items
    • balanceSheets.items.sections.items.code
    • and other 745 options... (see the whole list)

  • wrongValue string

    the value read from the API containing the mistake. In case of complex objects, please provide a string representation of them (the URL for websites or social accounts, the code and label for ATECO, the full address for offices, etc.)

  • correctValue string

    the correct value that should have been returned by the API

  • notes string

    some notes to show what the problem is, or to explain why it should be considered an issue

  • extraInfo string

    a json object to provide any extra information about the feedback; this might be required, prior to agreements between us, to allow automatic handling of the feedback request, and is client-dependant

curl -XPOST "https://api.atoka.io/v2/feedback" -d "item=123456789abcd" -d "collection=company" -d "field=base.legalName" -d "wrongValue=ACME S.R.L." -d "correctValue=ACME S.P.A."

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 -XPOST "https://api.atoka.io/v2/feedback" -d "explain=true"

Response modifications

When explain is true, the response will be:

{
"explanation": {
"collection": "company",
"item": "123456789abcd",
"field": "base.legalName",
"wrongValue": "ACME S.R.L.",
"correctValue": "ACME S.P.A."
}
}
curl -G "https://api.atoka.io/v2/feedback" -d "explain=true"

Response

The response of the feedback api

{
"error": false,
"explanation": {
"collection": "company",
"item": "123456789abcd",
"field": "base.legalName",
"wrongValue": "ACME S.R.L.",
"correctValue": "ACME S.P.A."
},
"queryExplanation": [
{
"engine": "foo",
"text": "foo",
"json": {"foo": "bar"}
},
...
]
}