Skip to main content

Usage Endpoints

Retrieve Server Usage Runs

This endpoint is used for offline usage reporting.

To retrieve the details about all Server usage runs, use the GET {baseURL}/v3/usage endpoint. This endpoint returns a TMP file containing run events. If you receive a 200 OK response, a Download File link is provided to download the file.

After you download the usage report, go to the Alteryx One UI and upload it...

  1. Sign in to Alteryx One as a Workspace Admin.

  2. Go to your Profile menu > Workspace Admin.

  3. Go to Monitoring > Offline Server Usage.

  4. Select Upload Server Data.

  5. Drag and drop or browse to your usage report (TMP file) and select Upload.

When the upload to Alteryx One completes, a confirmation file with the last provided record’s event ID will be automatically saved to your Downloads folder. Take the response file and upload it back to Server as described in Upload Server Usage Alteryx One Response File to Server.

Note

Only Curators (Server admins) can use this endpoint.

Parameters

No parameters.

Request Example: cURL

curl -X 'GET' \
  'http://pod-6650776.extendthereach.com/webapi/v3/usage' \
  -H 'accept: application/octet-stream' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Response Example

  • 200: Download usage records as a file.

  • 401: Unauthorized.

  • 404: No records are available for download.

  • 500: InternalServerError.

Upload Server Usage Alteryx One Response File to Server

This endpoint is used for offline usage reporting.

Upload the response file returned from Alteryx One to the Server using the POST {baseURL}/v3/usage endpoint.

When the Alteryx One file is successfully processed by the POST call, the reported run events are deleted from the database. The next file generated by the GET /v3/usage call retrieves run events that occurred after the last GET call.

Note

Only Curators (Server admins) can use this endpoint.

Parameters

file (formData): Required. Upload a file containing a single ULID (EventID). All usage events with EventIds less than or equal to this ULID are deleted.

Request Example: cURL

curl -X 'POST' \
  'http://pod-6650776.extendthereach.com/webapi/v3/usage' \
  -H 'accept: application/json' \
  -H 'authorization: BearerTokenGoesHere' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@ServerUsage.csv;type=text/csv'

Response Example

  • 200: Alteryx One response file processed and usage events cleanup complete.

  • 400: Missing or empty Alteryx One response file.

  • 401: Unauthorized. Occurs if a non-Curator attempts to use this endpoint or if an incorrect secret or key is provided.

  • 500: InternalServerError.

In this section: