{
  "opencollection": "1.0.0",
  "info": {
    "name": "Soracom and Query Analysis DataEntry API",
    "version": "20250903-043502"
  },
  "items": [
    {
      "info": {
        "name": "DataEntry",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get data sent to Harvest Data from a resource.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/data/:resource_type/:resource_id",
            "params": [
              {
                "name": "resource_type",
                "value": "",
                "type": "path",
                "description": "Type of data source resource."
              },
              {
                "name": "resource_id",
                "value": "",
                "type": "path",
                "description": "ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Start time for the data entries search range (UNIX time in milliseconds)."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "End time for the data entries search range (UNIX time in milliseconds)."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of data entries sent to Harvest Data from a device that match certain criteria. If the total number of entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n"
        },
        {
          "info": {
            "name": "Gets a data entry",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/data/:resource_type/:resource_id/:time",
            "params": [
              {
                "name": "resource_type",
                "value": "",
                "type": "path",
                "description": "Type of data source resource."
              },
              {
                "name": "resource_id",
                "value": "",
                "type": "path",
                "description": "ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n"
              },
              {
                "name": "time",
                "value": "",
                "type": "path",
                "description": "Timestamp of the target data entry to get (UNIX time in milliseconds)."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Gets a data entry identified with resource ID and timestamp"
        },
        {
          "info": {
            "name": "Deletes a data entry",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.soracom.io/v1/data/:resource_type/:resource_id/:time",
            "params": [
              {
                "name": "resource_type",
                "value": "",
                "type": "path",
                "description": "Type of data source resource."
              },
              {
                "name": "resource_id",
                "value": "",
                "type": "path",
                "description": "ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n"
              },
              {
                "name": "time",
                "value": "",
                "type": "path",
                "description": "Timestamp of the target data entry to delete (UNIX time in milliseconds)."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a data entry identified with resource ID and timestamp"
        },
        {
          "info": {
            "name": "Get data entries for a specific category",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/data/categories/:category",
            "params": [
              {
                "name": "category",
                "value": "",
                "type": "path",
                "description": "Name of the category to filter data entries."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Start time for the data entries search range (UNIX time in milliseconds)."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "End time for the data entries search range (UNIX time in milliseconds)."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of data entries that belong to a specific category. If the total number of entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n"
        },
        {
          "info": {
            "name": "Get the list of data source resources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/data/metadata/resources",
            "params": [
              {
                "name": "resource_type",
                "value": "",
                "type": "query",
                "description": "Type of data source resource.\n\n- `Subscriber`: IoT SIM.\n- `LoraDevice`: LoRaWAN device.\n- `Sim`: IoT SIM.\n- `SigfoxDevice`: Sigfox device.\n- `Device`: Inventory device.\n- `SoraCam`: Compatible camera device.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of data entries to retrieve."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of data source resources that have sent data. If the total number of data source resources does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n"
        },
        {
          "info": {
            "name": "Get the list of data source resources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/data/resources",
            "params": [
              {
                "name": "resource_type",
                "value": "",
                "type": "query",
                "description": "Type of data source resource.\n\n- `Subscriber`: IoT SIM.\n- `LoraDevice`: LoRaWAN device.\n- `Sim`: IoT SIM.\n- `SigfoxDevice`: Sigfox device.\n- `Device`: Inventory device.\n- `SoraCam`: Compatible camera device.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of data entries to retrieve."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of data source resources that have sent data. If the total number of data source resources does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n"
        }
      ]
    }
  ],
  "bundled": true
}