FQL v4 will be decommissioned on June 30, 2025. Ensure that you complete your migration from FQL v4 to FQL v10 by that date.

For more details, review the migration guide. Contact support@fauna.com with any questions.

/api/v1/logs/_list

List log retrievals for account.

HTTP authorization scheme:

bearer

Method

POST

Query parameters

type

required

string

Type of logs to retrieve.
Example: type=query

regionGroup

required

string

Region group. This parameter is not currently used so all region groups are accepted.
Example: us-std

Request body

Inputs bounding the logs you want to list.

Example:

Content-Type:

application/json

 
{
  "states": [
    "Complete",
    "Requested"
  ],
  "next_token": "slkdj823knl",
  "max_results": 100
}

Response

200 Success

next_token

string

Next token identifier.

results

object

See the following.

results object:

request_id

string

A unique identifier for your request. Pass to GET /api/v1/logs/${requestId} to poll for results.

database

string

Path of the database you want to get logs for, including the region group. This field is omitted when exporting logs for your region group.

region_group

string

Region group you want to get the logs for. Present only if you want to export logs for your region group.

time_start

required

string <date-time>

Date-time to start receiving logs, inclusive.

time_end

required

string <date-time>

Date-time to stop receiving logs, exclusive.

state

required

string (LogState)

Log state:

  • Complete Successful log receipt.

  • CreatingNewUrl Successful log receipt and creating URL for log retrieval.

  • DoesNotExist No logs exist for the request.

  • Failed Extraction failed.

  • Pending Successful request.

  • Requested Logs are submitted for extraction.

  • TimedOut Timed out before log received.

version

string

Optional request for controlling URL creation.

Example:

Content-Type:

application/json

 
{
  "next_token": "akljsaeu82l",
  "results": [
    {
      "request_id": "123",
      "database": "us-std/US",
      "region_group": "us-std",
      "time_start": "2020-01-01T00:00:00Z",
      "time_end": "2020-01-02T00:00:00Z",
      "state": "Pending",
      "version": 1
    }
  ]
}

HTTP error response

message

required

string

Example:

Content-Type:

application/json

 
{
  "message": "string"
}

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!