For the complete documentation index, see llms.txt. This page is also available as Markdown.

Datamart Queries

Operations related to OTQL Queries, the query language for datamarts based on GraphQL. OTQL (Object Tree Query Language) enables querying user data across millions/billions of objects using a SELECT/FROM/WHERE pattern. Queries can be saved as objects for reuse in segments, exports, and other features with performance optimization through caching.

Relevant documentation:

Execute an OTQL query with a segment id

post
/datamarts/{datamart_id}/queries/{query_id}/segments/{segment_id}/execution
Path parameters
datamart_idinteger · int64Required

The datamart for which we register the query

query_idstringRequired

The id of the query to execute. If provided, the body will be ignored

segment_idstringRequired

The segment id to decorate que query with

Query parameters
index_namestringOptional

The tree index to use. Default to USER_INDEX

limitinteger · int32Optional

In case of select queries, the limit of returned elements

offsetinteger · int32Optional

In case of select queries, the offset of the first element

precisionstring · enumOptional

Precision used to execute the query. Default to FULL_PRECISION

Possible values:
use_cachebooleanOptional

Use the cache

Header parameters
X-Mics-Otql-SourcestringOptional

Technical initiator

Body
stringOptional
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/queries/{query_id}/segments/{segment_id}/execution
POST /v1/datamarts/{datamart_id}/queries/{query_id}/segments/{segment_id}/execution HTTP/1.1
Host: api.mediarithmics.local
Content-Type: text/plain
Accept: */*
Content-Length: 6

"text"
{
  "status": "ok",
  "data": {
    "warning_message": "text",
    "took": 0,
    "limit": 0,
    "cache_result_ts": 0,
    "offset": 0,
    "result_type": "COUNT",
    "rows": "text",
    "precision": "FULL_PRECISION",
    "sampling_ratio": 0,
    "cache_hit": false,
    "timed_out": false
  }
}

Execute an OTQL query

post
/datamarts/{datamart_id}/query_executions/otql
Path parameters
datamart_idinteger · int64Required

The datamart for which we register the query

Query parameters
index_namestringOptional

The tree index to use. Default to USER_INDEX

queryIdstringOptional

The id of the query to execute. If provided, the body will be ignored

limitinteger · int32Optional

In case of select queries, the limit of returned elements

offsetinteger · int32Optional

In case of select queries, the offset of the first element

precisionstring · enumOptional

Precision used to execute the query. Default to FULL_PRECISION

Possible values:
use_cachebooleanOptional

Use the cache

Header parameters
X-Mics-Otql-SourcestringOptional

Technical initiator

Body
stringOptional
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/query_executions/otql
POST /v1/datamarts/{datamart_id}/query_executions/otql HTTP/1.1
Host: api.mediarithmics.local
Content-Type: text/plain
Accept: */*
Content-Length: 6

"text"
{
  "status": "ok",
  "data": {
    "warning_message": "text",
    "took": 0,
    "limit": 0,
    "cache_result_ts": 0,
    "offset": 0,
    "result_type": "COUNT",
    "rows": "text",
    "precision": "FULL_PRECISION",
    "sampling_ratio": 0,
    "cache_hit": false,
    "timed_out": false
  }
}

register a query

post
/datamarts/{datamart_id}/query_executions_async/otql
Path parameters
datamart_idstringRequired

The datamart for which we register the query

Query parameters
schema_idstringOptional

The schema against which we want to run the query (default to live)

tree_index_idstringOptional

The tree index on which we want to run the query (default to live)

query_engine_typestring · enumOptional

The engine type to run the query on - default to TREE_INDEX

Possible values:
data_warehouse_idstringOptional

The data warehouse id, required for SQL queries

Header parameters
X-Mics-Otql-SourcestringOptional

Technical initiator

Body
stringOptional
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/query_executions_async/otql
POST /v1/datamarts/{datamart_id}/query_executions_async/otql HTTP/1.1
Host: api.mediarithmics.local
Content-Type: text/plain
Accept: */*
Content-Length: 6

"text"
{
  "status": "ok",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "validation": {
      "type": "SUCCESS",
      "validation": {
        "parameters": [
          {
            "reference_model_type": "text",
            "parameter_name": "text",
            "type": "text",
            "container_type": "text",
            "reference_type": "text",
            "directive": "text",
            "data_type": "text",
            "path": [
              "text"
            ],
            "field_name": "text"
          }
        ]
      }
    }
  }
}

Translate a Json type query to an output_type query

post
/datamarts/{datamart_id}/query_translations
Path parameters
datamart_idstringRequired

Datamart id

Body
output_query_language_subtypestring · enumOptionalPossible values:
input_query_languagestring · enumRequiredPossible values:
output_query_languagestring · enumRequiredPossible values:
output_query_textstringRead-onlyRequired
input_query_textstringRequired
input_query_language_subtypestring · enumOptionalPossible values:
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/query_translations
POST /v1/datamarts/{datamart_id}/query_translations HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "output_query_language_subtype": "PARAMETRIC",
  "input_query_language": "SELECTORQL",
  "output_query_language": "SELECTORQL",
  "input_query_text": "text",
  "input_query_language_subtype": "PARAMETRIC"
}
{
  "status": "ok",
  "data": {
    "output_query_language_subtype": "PARAMETRIC",
    "input_query_language": "SELECTORQL",
    "output_query_language": "SELECTORQL",
    "output_query_text": "text",
    "input_query_text": "text",
    "input_query_language_subtype": "PARAMETRIC"
  }
}

Check OTQL queries

post
/datamarts/{datamart_id}/query_check/otql
Path parameters
datamart_idstringRequired

Datamart id

Body
querystringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/query_check/otql
POST /v1/datamarts/{datamart_id}/query_check/otql HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "query": "text"
}
{
  "status": "ok",
  "data": {
    "type": "SUCCESS",
    "validation": {
      "parameters": [
        {
          "reference_model_type": "text",
          "parameter_name": "text",
          "type": "text",
          "container_type": "text",
          "reference_type": "text",
          "directive": "text",
          "data_type": "text",
          "path": [
            "text"
          ],
          "field_name": "text"
        }
      ]
    }
  }
}

Autocomplete OTQL queries

post
/datamarts/{datamart_id}/query_autocomplete/otql
Path parameters
datamart_idstringRequired

Datamart id

Body
querystringRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
first_resultintegerRequired
totalintegerRequired
max_resultsintegerRequired
countintegerRequired
post/datamarts/{datamart_id}/query_autocomplete/otql
POST /v1/datamarts/{datamart_id}/query_autocomplete/otql HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "query": "text",
  "position": {
    "row": 0,
    "col": 0
  }
}
{
  "status": "ok",
  "first_result": 1,
  "total": 1,
  "max_results": 1,
  "data": [
    {
      "object_type_name": "text",
      "field_name": "text"
    }
  ],
  "count": 1
}

Get the result of a query

get
/datamarts/{datamart_id}/query_executions_async/otql/{query_id}
Path parameters
datamart_idstringRequired

The datamart for which we register the query

query_idstring · uuidRequired
Query parameters
answer_timeout_msinteger · int32Optional

max time to wait before answering (in milliseconds), either with the result or a running execution

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/datamarts/{datamart_id}/query_executions_async/otql/{query_id}
GET /v1/datamarts/{datamart_id}/query_executions_async/otql/{query_id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "type": "ERROR_RESULT",
    "query_status": "REGISTERED",
    "error": "TREE_INDEX_ERROR",
    "retryable": false
  }
}

Run asynchronously a submitted query

put
/datamarts/{datamart_id}/query_executions_async/otql/{query_id}
Path parameters
datamart_idstringRequired

The datamart for which we register the query

query_idstring · uuidRequired
Query parameters
use_cachebooleanOptional
answer_timeout_msinteger · int32Optional

max time to wait before answering (in milliseconds), either with the result or a running execution

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/datamarts/{datamart_id}/query_executions_async/otql/{query_id}
PUT /v1/datamarts/{datamart_id}/query_executions_async/otql/{query_id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "type": "ERROR_RESULT",
    "query_status": "REGISTERED",
    "error": "TREE_INDEX_ERROR",
    "retryable": false
  }
}

Get a query

get
/datamarts/{datamart_id}/queries/{id}
Path parameters
datamart_idinteger · int64Required
idinteger · int64Required
Query parameters
languagestring · enumOptional

Query language

Possible values:
favoritebooleanOptional

Query is favorite

Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/datamarts/{datamart_id}/queries/{id}
GET /v1/datamarts/{datamart_id}/queries/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "datamart_id": "text",
    "major_version": 0,
    "query_language_subtype": "PARAMETRIC",
    "query_text": "text",
    "favorite": false,
    "minor_version": 0,
    "query_language": "SELECTORQL",
    "id": "text"
  }
}

Update a query

put
/datamarts/{datamart_id}/queries/{id}
Path parameters
datamart_idinteger · int64Required
idinteger · int64Required
Body
datamart_idstringRead-onlyRequired
major_versioninteger · int32RequiredDefault: 0
query_language_subtypestring · enumOptionalPossible values:
query_textstringRequired
favoritebooleanRequiredDefault: false
minor_versioninteger · int32RequiredDefault: 0
query_languagestring · enumRequiredPossible values:
idstringRead-onlyRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/datamarts/{datamart_id}/queries/{id}
PUT /v1/datamarts/{datamart_id}/queries/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "major_version": 0,
  "query_language_subtype": "PARAMETRIC",
  "query_text": "text",
  "favorite": false,
  "minor_version": 0,
  "query_language": "SELECTORQL"
}
{
  "status": "ok",
  "data": {
    "datamart_id": "text",
    "major_version": 0,
    "query_language_subtype": "PARAMETRIC",
    "query_text": "text",
    "favorite": false,
    "minor_version": 0,
    "query_language": "SELECTORQL",
    "id": "text"
  }
}

Delete a query

delete
/datamarts/{datamart_id}/queries/{id}
Path parameters
datamart_idinteger · int64Required
idinteger · int64Required
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/datamarts/{datamart_id}/queries/{id}
DELETE /v1/datamarts/{datamart_id}/queries/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Translate a Json type expression to an output_type expression

post
/datamarts/{datamart_id}/expression_translations
Path parameters
datamart_idstringRequired

Datamart id

Body
output_query_language_subtypestring · enumOptionalPossible values:
input_query_languagestring · enumRequiredPossible values:
output_query_languagestring · enumRequiredPossible values:
output_query_textstringRead-onlyRequired
input_query_textstringRequired
input_query_language_subtypestring · enumOptionalPossible values:
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/expression_translations
POST /v1/datamarts/{datamart_id}/expression_translations HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "output_query_language_subtype": "PARAMETRIC",
  "input_query_language": "SELECTORQL",
  "output_query_language": "SELECTORQL",
  "input_query_text": "text",
  "input_query_language_subtype": "PARAMETRIC"
}
{
  "status": "ok",
  "data": {
    "output_query_language_subtype": "PARAMETRIC",
    "input_query_language": "SELECTORQL",
    "output_query_language": "SELECTORQL",
    "output_query_text": "text",
    "input_query_text": "text",
    "input_query_language_subtype": "PARAMETRIC"
  }
}

Cancel a query

post
/datamarts/{datamart_id}/query_executions_async/otql/{query_id}/action
Path parameters
datamart_idstringRequired

The datamart for which we register the query

query_idstring · uuidRequired
Body
actionstring · enumRequiredPossible values:
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/query_executions_async/otql/{query_id}/action
POST /v1/datamarts/{datamart_id}/query_executions_async/otql/{query_id}/action HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "action": "CANCEL"
}
{
  "status": "ok",
  "data": {
    "type": "ERROR_RESULT",
    "query_status": "REGISTERED",
    "error": "TREE_INDEX_ERROR",
    "retryable": false
  }
}

Execute a Json OTQL query

post
/datamarts/{datamart_id}/query_executions/jsonotql
Path parameters
datamart_idinteger · int64Required

The datamart for which we register the query

Query parameters
index_namestringOptional

The tree index to use. Default to USER_INDEX

queryIdstringOptional

The id of the query to execute. If provided, the body will be ignored

limitinteger · int32Optional

In case of select queries, the limit of returned elements

offsetinteger · int32Optional

In case of select queries, the offset of the first element

precisionstring · enumOptional

Precision used to execute the query. Default to FULL_PRECISION

Possible values:
use_cachebooleanOptional

Use the cache

Header parameters
X-Mics-Otql-SourcestringOptional

Technical initiator

Body
language_versionstringRequired
fromstringRequired
limitinteger · int32OptionalDefault: 0
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/query_executions/jsonotql
POST /v1/datamarts/{datamart_id}/query_executions/jsonotql HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 495

{
  "operations": [
    {
      "selections": [
        {
          "name": "text",
          "selections": [
            "[Circular Reference]"
          ],
          "directives": [
            "[Circular Reference]"
          ],
          "alias": "text"
        }
      ],
      "directives": [
        {
          "name": "text",
          "arguments": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ],
  "language_version": "text",
  "from": "text",
  "limit": 0,
  "join": [
    {
      "from": "text",
      "where": {
        "type": "GROUP",
        "expressions": [
          "[Circular Reference]"
        ],
        "negation": false,
        "boolean_operator": "AND"
      }
    }
  ],
  "where": {
    "type": "GROUP",
    "expressions": [
      "[Circular Reference]"
    ],
    "negation": false,
    "boolean_operator": "AND"
  }
}
{
  "status": "ok",
  "data": {
    "warning_message": "text",
    "took": 0,
    "limit": 0,
    "cache_result_ts": 0,
    "offset": 0,
    "result_type": "COUNT",
    "rows": "text",
    "precision": "FULL_PRECISION",
    "sampling_ratio": 0,
    "cache_hit": false,
    "timed_out": false
  }
}

Search document queries

get
/datamarts/{datamart_id}/queries
Path parameters
datamart_idinteger · int64Required
Query parameters
query_languagestring · enumOptional

Query language

Possible values:
query_language_subtypestring · enumOptional

Query language subtype

Possible values:
favoritebooleanOptional

Query is favorite

Responses
200

Success !

application/json
totalintegerRequired
first_resultintegerRequired
statusstring · enumRequiredPossible values:
max_resultsintegerRequired
countintegerRequired
get/datamarts/{datamart_id}/queries
GET /v1/datamarts/{datamart_id}/queries HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "total": 1,
  "first_result": 1,
  "status": "ok",
  "data": [
    {
      "datamart_id": "text",
      "major_version": 0,
      "query_language_subtype": "PARAMETRIC",
      "query_text": "text",
      "favorite": false,
      "minor_version": 0,
      "query_language": "SELECTORQL",
      "id": "text"
    }
  ],
  "max_results": 1,
  "count": 1
}

Create a query

post
/datamarts/{datamart_id}/queries
Path parameters
datamart_idinteger · int64Required
Body
datamart_idstringRead-onlyRequired
major_versioninteger · int32RequiredDefault: 0
query_language_subtypestring · enumOptionalPossible values:
query_textstringRequired
favoritebooleanRequiredDefault: false
minor_versioninteger · int32RequiredDefault: 0
query_languagestring · enumRequiredPossible values:
idstringRead-onlyRequired
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/datamarts/{datamart_id}/queries
POST /v1/datamarts/{datamart_id}/queries HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "major_version": 0,
  "query_language_subtype": "PARAMETRIC",
  "query_text": "text",
  "favorite": false,
  "minor_version": 0,
  "query_language": "SELECTORQL"
}
{
  "status": "ok",
  "data": {
    "datamart_id": "text",
    "major_version": 0,
    "query_language_subtype": "PARAMETRIC",
    "query_text": "text",
    "favorite": false,
    "minor_version": 0,
    "query_language": "SELECTORQL",
    "id": "text"
  }
}

Last updated

Was this helpful?