Skip to main content

QueryUserContentExports

A POST request that retrieves a list of your organization's user content exports. The endpoint is https://api.aware.work/external/search/v1/user-content-exports/query.

Access​

To access this operation, your API token must have one of the following permissions:

For more information, see the API token documentation.

Request Format​

Despite being a list operation that does not modify resources, QueryUserContentExports is a POST call.

Parameters​

None of the below parameters are required. However, they can assist you in selecting the data you're looking for more easily and efficiently than paging through all events depending on your use-case.

Note:

  • If a filter field is not provided, no filtration is performed on the corresponding field
  • If multiple filter fields are provided, events must match all filters in order to be returned
    • For example, setting both exportStartedAtOrAfterTime and exportStartedBeforeTime will return only events created between those two times.

The following is the full object:

{
  "criteria": {
    "exportStartedAtOrAfterTime": "",
    "exportStartedBeforeTime": ""
  },
  "pagination": {
    "pageNumber": 1,
    "pageSize": 30
  }
}

Query​

Below is the request in its most basic form. See request samples for more advanced query examples.

curl -X POST --location "https://api.aware.work/external/search/v1/user-content-exports/query" \
    -H "X-Aware-Api-Key: ${API_TOKEN}" \
    -H "Content-Type: application/json" \
    -d "{}"

Response Format​

If your request was successfully executed, the endpoint will return an HTTP 200 status and a response similar to the one below:

{
  "items": [
    {
      "exportId": "a1359bab-7c9b-cf58-d5aa-f853779868a9",
      "exportCriteria": {
        "exportUserEmail": "john.doe@example.com",
        "exportContentStartTime": "2024-03-01T00:00:00+00:00",
        "exportContentEndTime": "2024-03-03T23:59:59+00:00",
        "exportFormat": "Json"
      },
      "exportStatus": "Completed",
      "exportStartedTime": "2024-03-11T19:46:25.395707",
      "exportCompletedTime": "2024-03-11T20:05:52.3272034",
      "exportFileParts": [
        "idf-sf-ff5a8bf5-8063-45fc-81a7-a90b01334161\\80618b3a-f2f6-4aec-9877-cc5ff0a7f806"
      ]
    },
    ...
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "nextPage": null,
    "totalItems": 12
  }
}

Note that if the pagination.nextPage property is non-null, at least one additional page of results is available. If no additional results are available, the property will be null.

Request Samples​

Query for the first page of events between two timestamps​

curl -X POST --location "https://api.aware.work/external/search/v1/user-content-exports/query" \
    -H "x-aware-api-key: ${API_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
          "criteria": {
            "exportStartedAtOrAfterTime": "2024-01-14T21:32:02Z",
            "exportStartedBeforeTime": "2024-03-31T21:32:01Z"
          }
        }'

Query for the third page of events after a given time, limiting each page to 5 results​

curl -X POST --location "https://api.aware.work/external/search/v1/user-content-exports/query" \
    -H "x-aware-api-key: ${API_TOKEN}" \
    -H "Content-Type: application/json" \
    -d '{
          "criteria": {
            "exportStartedAtOrAfterTime": "2024-01-14T21:32:02Z"
          },
          "pagination": {
            "pageNumber": 3,
            "pageSize": 5
          }
        }'