General
I can't find the answer to my question. Who should I contact?
Submit your questions or feedback on the contact us page.
How do I add users to my organization?
To add users to their accounts, organization owners can follow these steps:
- Go to the home page.
- Click "Users" at the top of the screen to view the users in the organization.
- From the drop-down menu on the right, click "Invite User" and enter the required information.
- An email will be sent to the user to invite them to the organization and complete their account signup.
Security & Privacy
What security and privacy measures are in place?
Data Axle takes security and privacy very seriously. Our platform employs a range of measures to ensure the protection and confidentiality of your data. Read more about Data Axle Security and Privacy Policy.
Using Data
How do I get descriptions for the list of fields in my contract?
Descriptions of fields in your contract are available in the Data Dictionary and in our Schema Documentation.
How can I get field mappings for coded values in the data?
Our lookup tables include field mappings for coded values in the data. These tables contain mappings between coded values and their corresponding meanings. Find lookup tables under Lookups and read about the Lookups API.
Best Practices
File Deliveries
How do I know when a new delivery is available?
You will receive an email notification when new files are ready for delivery. To automate the detection of new files, utilize the File Delivery API, which allows you to programmatically check for and retrieve new files without manual intervention.
How are Data Axle files compressed?
Files are compressed using the gzip compression format. To unzip these files, we recommend using the 7-Zip File Manager. It is a free, Windows-friendly tool that does not require registration and supports various types of compressed files.
Why is a delivery broken into several files?
Deliveries are broken into several files, with each file containing approximately one million records to ensure manageability. This approach makes it easier to process and work with the data in a more efficient manner. If you need to increase the file limit, please reach out to your support team for assistance.
In what order should I import files?
You can import files in any order since there are no specific requirements regarding the sequence.
What time of the day are Incremental Files generated?
Incremental Files start generating after 8:00 am UTC, with the exact generation time varying based on file size. For Weekly Incremental Files, generation begins at 8:00 am UTC every Monday.
How do I process the monthly file in relation to the Daily Incremental Files?
Process the monthly file as soon as it becomes available to ensure you have the most up-to-date data. After processing the monthly file, apply any further updates using the Daily Incremental Files to keep your data current. This approach ensures that you are working with the most recent data while maintaining the integrity of your dataset.
In what order should I import the Incremental Files?
To ensure that you have the most current data, we recommend importing Incremental Files in chronological order, starting with the oldest files and progressing to the most recent ones.
How often should I look for new files?
Below are some best practices you can follow in order to stay up to date with new file deliveries:
- Monthly Files: Check for new monthly files between the 1st and the 5th of each month.
- Weekly Files: Check for new weekly files every Monday at 8:00 am UTC.
- Daily Files: Check for new daily files every day at 8:00 am UTC.
To automate this process, use the File Delivery API once per hour to check for new files. This approach ensures that you receive new files promptly while minimizing the frequency of API calls.
General API
How do I generate an auth token?
See the Authentication Documentation to generate an API token. This documentation will provide the necessary steps and guidelines to create an API token that you can use for authentication purposes.
Do I need a separate auth token for each API?
No, you do not need a separate authentication token for each API. Each user only needs one authentication token, which can be used across all services.
What API software/applications does Data Axle recommend?
We recommend using Insomnia REST API or Postman.
Is there a limit to the number of requests that can be made through the API?
Yes. The API limits requests to 150 requests per 10 seconds. This limit helps ensure fair usage of the API and prevents abuse or overloading of the system.
What is the uptime of the API?
The Data Axle Status Dashboard shows the uptime of each API.
Are there different endpoints to access the different databases you offer (business vs. consumer)?
Yes, each database and API have their own specific endpoints. Please see the API documentation for each endpoint.
Search API
Why aren’t all records that match my criteria returned?
The Search API returns up to 10 records by default. To retrieve more results, you can use the limit and offset parameters to specify the number of records to return and the starting point for the result set.
If you regularly need to retrieve large sets of records, consider using the Scan API, which is designed for efficiently retrieving large amounts of data.
Why do I see different records if I make the same request at a later time?
You may see different records when making the same request at a later time due to updates and additions to the database. As records are updated or new records are added, the results of your search will reflect these changes. Additionally, the order in which records are returned may vary.
To control the sorting behavior of your results, you can apply a sort parameter to your request to ensure consistency in the order of returned records.
Does the ordering of my filters matter?
No, the ordering of your filters does not matter. Filters can be applied in any order, and the results will remain the same regardless of the order in which they are applied.
Scan API
What is the difference between the Scan API and Search API?
The Search API will return up to 100 records in a single request. The Scan API is more useful for retrieving large sets of records, and allows you to scroll (paginate) through all records that meet your criteria.
Another key difference is that the Search API supports the use of the query parameter to specify your search criteria. (The Scan API does not.)
Can I get the number of records that meet my criteria before returning the full list of records?
The initial response from the API includes the total number of records that match your query criteria. This allows you to preview the number of records without retrieving the full list. Additionally, you can use the Insights API to get detailed counts and statistics about your data
Match API
What are the expected response times for the Match API?
The expected response times for the Match APIs are as follows:
Single match requests typically return a result within 500 milliseconds.
Bulk match requests, which involve matching multiple records, return results within 1000 milliseconds.
These response times are based on typical performance expectations and may vary depending on factors such as network conditions and server load.
Are there any API request or file size limitations when using the Match APIs?
There are no restrictions on individual file sizes when using the Match APIs, and you can include numerous match requests in a single API batch request. However, there is a limit of 1,000 match requests per API request. If you need to match more than 1,000 records, you will need to split your requests into multiple batches to stay within this limit.
Will non-matchable input fields be returned via Match API?
No. Only the fields available on the match template are returned in the API. Use the optional reference ID field to reference IDs from your system.
Does the next_token expire when scrolling through match results?
Yes. The next_token expires after 1 year or when the match request is deleted.
File Delivery API
Where can I find my subscription IDs?
Each subscription is assigned a unique identifier, which is accessible through the UI or API:
- UI - On the “account” tab, click on one of your subscriptions to view the delivery details. On the following page, the subscription ID is listed in the URL. Example: platform.data-axle.com/places/subscriptions/:subscription_id
- API – The subscription ID, subscription name, and delivery details are returned when specifying a delivery. Example: https://api.data-axle.com/v1/deliveries/:delivery_id. From there, the subscription ID can be used to identify new deliveries.