Usage Endpoints

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...

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.

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

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.

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'