Users

Get data harvest status

Changed on

Retrieves detailed status information for a specific data harvest. Shows progress, completion status, and other metadata about the harvest request.

get/users/@me/harvest/{harvestId}

Request

  • Base URL: https://web.fluxer.app/api/v1
  • URL: https://web.fluxer.app/api/v1/users/@me/harvest/{harvestId}
  • Auth: API key in header Authorization

Path parameters

string snowflake required
OR
integer required

The ID of the harvest request

Response

Success

harvest_idstring snowflake required
status'pending' | 'processing' | 'completed' | 'failed' required

Current status of the harvest request

created_atstring required

ISO 8601 timestamp when the harvest request was created

started_atstring nullable required

ISO 8601 timestamp when the harvest started, or null if pending

completed_atstring nullable required

ISO 8601 timestamp when the harvest completed, or null otherwise

failed_atstring nullable required

ISO 8601 timestamp when the harvest failed, or null otherwise

file_sizestring nullable required

Final file size of the downloaded data, expressed as a string, or null if not available

progress_percentnumber required

Harvest progress as a percentage value between 0 and 100

progress_stepstring nullable required

Textual description of the current harvest step, if available

error_messagestring nullable required

Error message when the harvest fails, or null otherwise

download_url_expires_atstring nullable required

ISO 8601 timestamp when the download URL expires, or null if unavailable

expires_atstring nullable required

ISO 8601 timestamp when the harvest download expires, or null if unavailable

Changes

  • dd0ad4ea1c88Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      response property completed_at list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property download_url_expires_at list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property error_message list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property expires_at list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property failed_at list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property file_size list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property progress_step list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property started_at list-of-types was narrowed by removing types null from media type application/json of response 200

  • a52a2cf49d9bRevision changes
    • warning

      added the new IP_BAN_DECLINED enum value to the response property for the response status

    • warning

      added the new IP_BAN_DECLINED enum value to the response property for the response status

    • warning

      added the new IP_BAN_DECLINED enum value to the response property for the response status

    • warning

      added the new IP_BAN_DECLINED enum value to the response property for the response status

    • warning

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new PHONE_COUNTRY_NOT_SUPPORTED enum value to the response property for the response status

    • warning

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_GATE_ESCAPE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

    • warning

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

    • warning

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

    • warning

      added the new PHONE_INBOUND_VERIFICATION_REQUIRED enum value to the response property for the response status

    • warning

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_LOOKUP_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_IN_SERVICE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

    • warning

      added the new PHONE_NUMBER_NOT_MOBILE enum value to the response property for the response status

    • warning

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

    • warning

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

    • warning

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

    • warning

      added the new PHONE_VERIFICATION_NEEDS_REVIEW enum value to the response property for the response status

    This list may be incomplete.