Fetch analysis

There are two ways to fetch the analysis

A. Through a webhook

To retrieve analysis results asynchronously, the recommended approach is through webhooks. Follow the steps outlined in our guide on setting up webhooks here to configure this process.

Subscribe to two distinct events: analysis_completed and analysis_failed.

• analysis_completed: This event is dispatched upon successful completion of the analysis. The payload of the analysis_completed event includes the customerId and analysisId.
• analysis_failed: In case the analysis encounters an error or failure, the analysis_failed event is triggered.

Once the analysis is successfully completed, use the analysis_completed event's payload (customerId and analysisId) to retrieve the analysis details. Make a GET request to the get analysis route.

Should the analysis fail, you will receive the analysis_failed event indicating the occurrence of an issue during the analysis process.

B. Through API requests

Option 1

1. Get the customerId of your customer with its customIdentifier : v2/customers?filter={"customIdentifier": "customIdentifier"}
2. List the analysis of the customer : /v2/customers/{customerId}/analyses
3. Check the most recent analysis : /v2/customers/{customerId}/analyses/{analysisId}

Option 2

1. Thanks to the customerId returned as a query parameter of the redirect_uri , the client can get the analysisId of the last analysis performed for by listing all the analysis of this customer
2. The client can then get the analysis by calling the route : /v2/customers/{customerId}/analyses/{analysisId}

C. Through the Dashboard

If you have a Dashboard license, you can see the results of the analysis on Algoan Dashboard.