Assistance with QuantifyAPI Integration for Custom Reporting

Sample Files
1

Hello Everyone :hugs:,

I’m contacting you to ask for guidance on adding QuantifyAPI to our current system so that we may use it for customised reports. Right now, we’re pulling data for several metrics via the API, but we’ve run into a few problems that I hope someone here can help with.

Our main objective is to provide personalised reports that are suited to our particular requirements and incorporate information from various sources in our system.

We’ve successfully configured the bare minimum of API calls to retrieve data, but we’re having trouble with a few things:

Complex Data Aggregation: To produce an extensive report, we must merge data from multiple distinct endpoints. Is there a way to rapidly aggregate data from several API answers without sacrificing quality? :thinking:

Filtering and Sorting: Prior to producing reports, we wish to apply unique filters and sorting standards to the data. What are the best ways to handle this inside the scope of QuantifyAPI? :thinking:

Error Handling: In particular, rate constraints and unexpected data formats have caused us to run into some problems with error answers. I’d be grateful for any advice on strong error handling and maintaining data integrity.

Optimising Performance: We’re worried about how our API requests will affect performance as our data volume increases. When working with big datasets, are there any best practices or optimisation strategies that can improve performance? :thinking:

https://quantifyapi.avontus.com/t/using-api-to-change-field-to-read-only-in-quantify-ui/servicenow

Any guidance, documentation, or examples that could assist us get past these obstacles would be greatly appreciated. Please let me know if you have any recommendations for specific tools or libraries to use when working with QuantifyAPI.

Thank you :pray: in advance.

2

Hello Arthur. Thank you for posting on our forum.

We have several documents to get you started that are pinned to the front page of the forum site here.

In your case I would recommend that you read data from Quantify on a regular interval, and then write this data to an external data source. You can then complete your reporting on this external data source and be independent of unnecessary connections to the Quantify database (which is why we recommend the API).

To get started I feel free to peruse through the sample code. You will need to know C# and .NET. There’s a great starter app that reads data from jobsites. I would also recommend that you learn Quantify as the API uses the same terminology as the desktop app, and for the most part the API is the same. For example, to get a shipment you would use the following code.

 // get a shipment  
 Shipment ship = Shipment.GetShipment(shipmentID);

From here you can read the quantities from the child collection of shipment products.

 foreach (ShipmentProduct product in ship.ShipmentProducts)

For anything else, just ask in a forum post here and we’ll give you sample code.

Sincerely
AvontusDev