Skip to main content

TitanHQ Product Docs

Data Offload (Customer)

Data offload of your DNS requests in log file format is available in WebTitan using our Data Offload API set. These APIs allow you to download your most recent traffic data (up to the previous 5 days) from an Amazon S3 bucket in Gzip format. Authentication is through the WebTitan API.

Once authenticated, a Customer admin can follow the steps below to view the available logs and download one or all log files. The following are helpful to complete the steps below:

Important

In WebTitan log files, DNS requests match the time zone specified during WebTitan setup. However, the timestamp used in a log file name is UTC. Therefore, if you are looking for a log file for a specific time, you must adjust that time to UTC and locate the log file with the UTC-adjusted time stamp.

  1. Complete the WebTitan API Authentication steps.

    Authentication for data offload is through the WebTitan API. If you are not already authenticated, complete the WebTitan API Authentication steps.

  2. Get your Customer UUID (optional).

    Your Customer UUID can be used as an optional parameter in the steps that follow.

    1. Use the Get a User API. See Get User.

    2. Send the request without parameters.

      Your Customer UUID is returned in uuid_str. For example, the Customer UUID below is 4d20e977-0ec4-434a-b21d-2c529fb1d062:

      {
      "object": "user",
      "code": "200",
      "id": "1",
      "created": "2018-06-25 10:03:56",
      "accountname": "John",
      "description": "Example User",
      "timezone": "Europe/London",
      "email": "email@example.com",
      "license": "WCE-M-0000-005599",
      "lastlogin": "2018-06-26 10:03:56",
      "install_key": "4d20e977-0ec4-434a-b21d-2c529fb1d062",
      "2fa_enabled": false,
      "suspended": false,
      "uuid_str": "4d20e977-0ec4-434a-b21d-2c529fb1d062"
      }
  3. Get a list of your log files.

    Data log files are retained for 5 days. You can download a list of all log files, or just the log files for a specific date.

    • To get a full list of log files, use the List all customer log files API. See List all customer log files.

      Send this call without any parameters.

      A list of your log files are returned. For example, the log file name below is filename-with-timestamp.extension.

      {
      "object": "logs",
      "code": 200,
      "data": [
      "0130ae8f-3712-4dad-9e1b-f2ad5ebc136c/2022-07-13/filename-with-timestamp.extension",
      "0130ae8f-3712-4dad-9e1b-f2ad5ebc136c/2022-07-13/filename-with-timestamp.extension"
      ]
      }
    • To get the log files for a specified date you can also use the List all customer log files API. See List all customer log files.

      Send your Customer UUID with a date appended in YYYY-MM-DD format in the prefix parameter.

      A list of your log files for the specified date is returned. For example, 0130ae8f-3712-4dad-9e1b-f2ad5ebc136c/2022-07-13

  4. Download the log file(s).

    You can download all your log files or a single log file.

    • Use the Download all log files for a specified date (Customer Admin) API to download all log files listed in Step 2. See Download all log files for a specified date (Customer Admin).

      • Pass the specific date you want to download log files for in the date parameter in YYYY-MM-DD format.

    • Use Download a single log file for a specified date (Customer Admin) to download a single log file for a specific date. See Download a single log file for a specified date (Customer Admin).

      1. Pass the log file date in YYYY-MM-DD format in the date parameter.

      2. Pass the log file name of the single log file you want to download in the filename parameter.

        Tip

        In WebTitan log files, DNS requests match the time zone specified during WebTitan setup. However, the timestamp used in a log file name is UTC. Therefore, if you are looking for a log file for a specific time, you must adjust that time to UTC and locate the log file with the UTC-adjusted time stamp.

      3. When saving the log file to your local machine, ensure you save it with the .gz extension. For example, filename.gz.