Sql credential usage

cURL

curl --request GET \
  --url "https://api.rafflesia.ai/v1/sql-credentials/{credential_id}/usage?from=<from>&to=<to>" \
  --header "Authorization: Bearer $RAFFLESIA_API_KEY"

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

GET

sql-credentials

{credential_id}

usage

cURL

curl --request GET \
  --url "https://api.rafflesia.ai/v1/sql-credentials/{credential_id}/usage?from=<from>&to=<to>" \
  --header "Authorization: Bearer $RAFFLESIA_API_KEY"

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

{
  "ok": true,
  "provenance": {
    "created_at": "<string>",
    "operation": "<string>",
    "request_id": "<string>",
    "server_version": "<string>",
    "cache_hit": true,
    "database_snapshots": [
      {
        "name": "<string>",
        "version": "<string>",
        "digest": "<string>",
        "kind": "<string>"
      }
    ],
    "generated_object_ids": [
      "<string>"
    ],
    "input_hash": "<string>",
    "parameters_hash": "<string>",
    "tool_versions": [
      {
        "name": "<string>",
        "version": "<string>",
        "path": "<string>"
      }
    ]
  },
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    }
  ],
  "$schema": "https://example.com/schemas/EnvelopeSQLCredentialUsageData.json",
  "data": {
    "credential_id": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "usage": [
      {
        "clickhouse_user": "<string>",
        "credential_id": "<string>",
        "failed_query_count": 123,
        "first_query_at": "2023-11-07T05:31:56Z",
        "last_query_at": "2023-11-07T05:31:56Z",
        "peak_memory_bytes": 123,
        "query_count": 123,
        "query_duration_ms": 123,
        "read_bytes": 123,
        "read_rows": 123,
        "result_rows": 123
      }
    ]
  },
  "error": {
    "code": "<string>",
    "doc_url": "<string>",
    "message": "<string>",
    "type": "invalid_request_error",
    "details": {},
    "param": "<string>"
  },
  "evidence": {
    "warnings_count": 123,
    "duration_ms": 123,
    "input_refs": [
      "<string>"
    ],
    "object_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "row_count": 123
  }
}

Authorizations

Authorization

string

header

required

A Rafflesia API key, sent as Authorization: Bearer <key>.

Path Parameters

credential_id

string

required

Minimum string length: 1

Query Parameters

organization_id

string

environment_id

string

from

string<date-time>

required

string<date-time>

required

Response

boolean

required

Whether the operation succeeded.

provenance

object

required

Execution provenance.

Show child attributes

warnings

object[] | null

required

Non-fatal warnings.

Show child attributes

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/EnvelopeSQLCredentialUsageData.json"

data

object

Operation result data. Absent when the operation did not succeed.

Show child attributes

error

object

Structured error information.

Show child attributes

evidence

object

Mechanical evidence summary for agent inspection and chaining.

Show child attributes

Reference

Endpoints

Sql credential usage

Authorizations

Path Parameters

Query Parameters

Response