Information

Endpoints in this group provide basic api status via GET /status and configuration info. It also allows to validate an api via the endpoint /login.

Configuration information

Information about the user can be obtained via GET /user_info. This will provide information about the API version the user is using, the client's username, the video storage used and left in uploaded_video_storage and product type. Moreover, information about the subscription is also displayed, with the expiration_date, remaining_minutes and consumed_minutes. If the API Key used has 'children' API Keys configured, the subscription information for those API Keys is also available in children_subscription. This endpoint also shows if the track logger is enabled. The information will be shown as follows:

{
  "version": "v2.11.0",
  "uploaded_video_storage": {
    "max_video_upload_size_bytes": 0,
    "total_storage_size_bytes": 0
  },
  "product": "ATR",
  "username": "your-username",
  "subscription": {
    "remaining_minutes": 2500,
    "consumed_minutes": 15,
    "expiration_date": "2035-04-21",
    "pending_to_allocate": 0
  },
  "children_subscription": [
    {
      "remaining_minutes": 0,
      "expiration_date": "2035-04-21",
      "pending_to_allocate": 0,
      "username": "string"
    }
  ]
  "is_track_logger_enabled": True
}

The subscription information will let you know about the remaining processable minutes and expiration date of your API Key. The pending_to_allocate minutes show minutes that have been purchased but not allocated to your account. In order to do so, contact with support@senseaeronautics.com.

If you have a Master API Key you can distribute the pending_to_allocate minutes to any of the multiple API Keys you own.

Deprecated: Information about the user prior to v2.11.0 could be obtained via GET /info. This endpoint is deprecated, but can still be used. Please, use GET /user_info instead. Information will be shown as follows:

{
  "version": "v2.10.5",
  "uploaded_video_storage": {
    "max_video_upload_size_bytes": 0,
    "total_storage_size_bytes": 0
  },
  "subscription": {
    "consumed_minutes": 1500,
    "remaining_minutes": 2500,
    "expiration_date": "2035-04-21"
  },
  "product": "ATR"
}