Datapipe
Community
Enterprise

Gets analysis request information

Changed on

Returns the current analysis request information. Always returns 200 OK with the request details. When no request is pending, returns a zero-valued response with empty strings, false booleans, null arrays, and zero timestamp.

get/api/v2/analysis

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/analysis
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Response

OK. Returns analysis request details if one exists, or a zero-valued response if no request is pending (requested_by and request_type will be empty strings, requested_at will be "0001-01-01T00:00:00Z", booleans will be false, and arrays will be null).

Changes

  • 9bacd5cb0634Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • a7eb8f49002cRevision changes
    • info

      endpoint added