datasets

Get Dataset

get/api/v1/dataset/{provider}/{name}/

Request

  • Base URL
    https://data.corva.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Path parameters

providerstring required
namestring required

Response

Successful Response

company_idinteger nullable
providerstring
namestring
descriptionstring nullable
schemaobject
data_type'time' | 'depth' | 'reference' | 'timeseries'
settingsobject
permission_workflowobject
plottableboolean
temporaryboolean
idinteger required
friendly_namestring

Example response

{
  "company_id": 123,
  "provider": "corva",
  "name": "corva#wits",
  "description": "Save WITS data",
  "schema": {},
  "settings": {},
  "permission_workflow": {
    "delete": "request",
    "read": "request",
    "write": "request"
  },
  "id": 15,
  "friendly_name": "wits",
  "indexes": [
    {
      "fields": [
        {
          "_id": 1
        }
      ],
      "name": "_id_",
      "statistics": {
        "size": 165238,
        "usage": 12.2995
      },
      "status": "active"
    },
    {
      "fields": [
        {
          "asset_id": 1
        },
        {
          "timestamp": -1
        }
      ],
      "name": "asset_id_timestamp",
      "statistics": {
        "size": 292310,
        "usage": 923.18823
      },
      "status": "active",
      "unique": true
    }
  ],
  "statistics": {
    "size": 1000000,
    "count": 282034,
    "storage_size": 8839043,
    "index_size": 199234282
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.