{"added":{"user.email":"[email protected]"},"removed":{},"changed":{"user.age":{"from":30,"to":31}}}
curl --location --request POST 'https://zylalabs.com/api/13165/data+structure+tools+api/26711/compare+two+documents' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"a": {"user": {"age": 30}}, "b": {"user": {"age": 31, "email": "[email protected]"}}}'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Data Structure Tools API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Trusted by leading companies
A complete toolbox for structured data documents behind a single key. Format and validate, flatten deeply nested documents into dot notation keys and rebuild them, compare two documents field by field, and convert arrays of records to and from spreadsheet friendly comma separated text.
Useful for detecting configuration drift between environments, handing data to spreadsheet users, flattening documents for database columns, and cleaning data in delivery pipelines.
The Compare Two Documents endpoint returns a structured JSON object that highlights differences between two documents. It categorizes changes into "added," "removed," and "changed," providing the dot notation path for each field along with old and new values for any changes.
The key fields in the response data include "added," "removed," and "changed." Each of these fields contains nested objects that represent the differences between the two documents, with paths indicating the location of each change.
The response data is organized into three main sections: "added" for new fields, "removed" for fields that no longer exist, and "changed" for fields that have been modified. Each section uses dot notation to specify the path to the affected fields.
The Compare Two Documents endpoint provides information on structural changes between two documents, including which fields were added, removed, or changed, along with their respective values before and after the change.
Users can customize their data requests by providing two structured documents in the request body. The API will then compare these documents based on their structure and content, returning a detailed comparison.
Typical use cases include detecting configuration drift between environments, validating data integrity during migrations, and ensuring consistency in structured data across different applications or systems.
Data accuracy is maintained through in-memory processing, which ensures that the documents are compared directly without storage, minimizing the risk of data corruption or loss during the comparison process.
If there are no differences between the documents, the response will indicate empty "added," "removed," and "changed" fields. Users can check these fields to determine if the documents are identical or if specific changes need to be addressed.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund