Async Job - Request EU Tax Values for Organizations

post

https://api.clarity.ai/clarity/v1/public/organizations/eu-taxonomy/{objective}/metric-by-id/async

This endpoint will make a request to asynchronously retrieve extensive EU Tax information.

The asynchronous process will generate a file with EU Tax values for the whole universe of organizations or a subset of it if a list of Perm Ids is included in 'permIds' parameter.
Results depend on the objective in the URL and on kpi in the request body.
Use metricIds to choose which metrics to include; if omitted or empty, all available metrics are returned when permitted for your account.
Use optionalColumns to add extra fields: REPORTING_LEVEL, DISCLOSURE, NFRD, METRIC_YEAR, NON_MATERIAL, OMNIBUS_TEMPLATE, NO_ACTIVITIES_CLAIMED, or GROUPED_NUCLEAR_FOSSILGAS.
Use permIds to limit the export to specific organizations, or leave empty to include all organizations.

Please note:

This call will only return the identifier (uuid) for this task. You'll need this value to:

Know the status of your job (see Async Job - Get job status)
Download your file when ready (see Async Job - Download compressed result file)

Please refer to Universe API's Technical documentation for a complete explanation of the workflow for these asynchronous job endpoints.

Path Params

objective

string

enum

required

EU Taxonomy objective. Allowed values: adaptation,aggregation,biodiversity,circular,mitigation,pollution,water

Allowed:

Query Params

headerPrefix

string

Adds a custom prefix to the exported column names

Body Params

optionalColumns

array of strings

enum

Additional data fields to include in the export. Allowed values: REPORTING_LEVEL, DISCLOSURE, NFRD, METRIC_YEAR, NON_MATERIAL, OMNIBUS_TEMPLATE, NO_ACTIVITIES_CLAIMED, GROUPED_NUCLEAR_FOSSILGAS. REPORTING_LEVEL and DISCLOSURE are equivalent. NON_MATERIAL only applies when the objective is aggregation.

optionalColumns

metricIds

array of strings

EU Taxonomy metrics to include. Valid values depend on the objective in the URL. If omitted or empty, all available metrics are returned when permitted for your account; otherwise the request is rejected.

metricIds

permIds

array of strings

Perm IDs of the organizations to include. If omitted or empty, all organizations are included. Maximum 25000 IDs.

permIds

kpi

string

enum

Financial indicator used for the metrics. Allowed values: TURNOVER, REVENUE, CAPEX, OPEX. TURNOVER and REVENUE are equivalent. Defaults to TURNOVER when omitted.

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The jobs request has been accepted, uuid follows

400Bad parameters on request: 2200 - The job was accepted but some error happened while processing 2006 - At least one of the scores requested does not exist or this account does not have permission to access it 7000 - Objective is not valid.

401Invalid grant: 1000 - Invalid authentication token or expired

403Forbidden: 1001 - This account does not have permission to access this resource

413Invalid request: 2101 - The limit of 25.000 ids in the same request has been exceeded