Skip to main content

Search Datamaps

Searches across Datamaps and other data objects using filters, pagination, and optional sorting. This endpoint returns detailed metadata about matching Datamaps, including ownership, status, field definitions, and usage metrics.

Endpoint​

POST https://api.prod.promethium.ai/datamap/search

Headers​

Header NameValueRequiredDescription
Content-Typeapplication/json✅Specifies the format of the request body
idtoken<authentication_id_token>✅Bearer token obtained via authenticated login

Request Body​

{
  "q": "customer churn",
  "from": 0,
  "size": 10,
  "sort_key": "updated_ts",
  "sort_value": "desc",
  "advance_options": {
    "type": "DATAMAP"
  }
}

Request body​

The request body provides optional search and sort parameters.

 {
 "q": string,
 "from": int,
 "size": int,
 "sort_key": enum
 "sort_value": enum,
 "advance_options": {
 "type": enum
 }
 }
FieldTypeRequiredDescription
qstring❌Full-text search query
frominteger❌Starting index for pagination (default: 0)
sizeinteger❌Number of records to return (default: 10, max: 10000)
sort_keyenum❌Field to sort by: updated_ts, curated_info.query_count, relevance, table_name.lowercase
sort_valueenum❌Sort direction: asc or desc
advance_options.typeenum❌Object type to filter: DATAMAP, TABLE, or VIEW

Example Response​

✅ Success (200 OK)​

 {
 "total": 41,
 "max_supported_records": 10000,
 "data": [
 {
  "id": "xgYcE5cBfVYg6CGP8FY8",
  "score": 0.0,
  "remarks": null,
  "description": null,
  "source_id": "sys_pm61_WKdV7kwfza7zbTcbeF9pRX",
  "source_name": "My-Source",
  "created_ts": 1748372352475,
  "updated_ts": 1748372352475,
  "type": "DATAMAP",
  "database_name": "promethium",
  "vendor_name": "Promethium",
  "location": "dev-aws-trino.dev.promethium.ai",
  "schema": "promethium",
  "catalog": "hive",
  "field_count": 0,
  "tags": [],
  "fields": [],
  "average_rating": 0.0,
  "favourite_count": 0,
  "tag_count": 0,
  "answer_count": 0,
  "query_count": 0,
  "comment_count": 0,
  "view_count": 43,
  "upvote_count": 0,
  "downvote_count": 0,
  "datamap": {
              "name": "revenue_by_quarter",
              "display_name": "revenue_by_quarter",
              "state": "IN_PROGRESS",
              "import_type": "NONE",
              "fact_map": {},
              "assigned": {
                            "to": null,
                            "sme": null,
                            "from": "user@acme.com",
                            "last_updated_timestamp": 1748372352475
                          },
              "priority": "HIGH",
              "config": {
              "is_advanced_mode": false,
              "redash_query_id": null,
              "redash_query_name": null,
              "selected_data_source_id": "1",
              "advance_selected_data_source_id": null,
              "limit": 100
            },
  "advanced_mode": {
  "sql": null,
  "source_ids": [
        "rQAVqpUBfVYg6CGPTQOk",
        "rAAVqpUBfVYg6CGPTQOk"
      ],
  "sources": null
 },
  "created_by": "user@acme.com",
  "updated_by": "user@acme.com",
  "last_published_by": null,
  "created_timestamp": 1748372352475,
  "last_updated_timestamp": 1748372352475,
  "last_published_timestamp": null,
  "last_execution_timestamp": null,
  "datamap_fields": [
 {
  "name": "trx_id",
  "data_type": 0,
  "java_type": "java.math.BigDecimal",
  "column_size": 0,
  "decimal_digits": 0,
  "description": "Transaction ID.",
  "tags": [],
  "auto_increment": ""
 },
 {
  "name": "value",
  "data_type": 0,
  "java_type": "java.lang.String",
  "column_size": 0,
  "decimal_digits": 0,
  "description": "Revenue",
  "tags": [
      "bookings"
    ],
  "auto_increment": ""
 }
  ],
  "explainer": [],
  "explanation": ""
 },
  "topic_ids": [],
  "pcode_ids": null,
  "user_activity": {
  "id": "ygYdE5cBfVYg6CGPAFbw",
  "type": "FACT",
  "associated_id": "xgYcE5cBfVYg6CGP8FY8",
  "user_id": "user@acme.com",
  "is_favourite": null,
  "rating": null,
  "vote": null,
  "viewed": 43,
  "marketplace": null,
  "created_timestamp": null,
  "last_updated_timestamp": null,
  "last_viewed_timestamp": 1748544784646
 },
 "score_breakdown": [],
 "score_breakdown_details": [],
 "recommendations": [],

Endpoint​

GET https://api.prod.promethium.ai/datamap/{id}

Headers​

Header NameValueRequiredDescription
Content-Typeapplication/json✅Specifies the format of the request body
idtoken<authentication_id_token>✅Bearer token obtained via authenticated login

Response​

A single record with the same metadata as returned in the Example datamap search API response above.