-4.png?width=100&height=75&name=Wordnerds%20Logo%20Yellow%20and%20Black%20On%20Transparent%20(RGB)-4.png){kind=spacer}
What is an API?
There are two ways to get your data into the Wordnerds platform. We generally recommend everyone starts with a manual upload. For details on how to do that, see our guide. For those who are ready for an automated data stream, you'll want to connect to our input API.
An API stands for Application Programming Interface. It’s essentially a bridge between two platforms that allows data to be passed from one to the other.
What is it good for?
- Giving you real time insights from live data
- For high volume, regular data flows such as contacts through your CRM
- Reduces time spent on manually uploading
- Secure way to send Wordnerds data if there are DPIA issues over email/shared files
What data sources can I connect via API?
Our Input API is flexible and the documentation is written so any data source can push the data to us. The only limitation is that we do not as standard write bespoke code to pull data from different sources into the platform.
How long does connecting a new data source via API take?
Because all datasets are so different, dev team workloads vary and customer needs are sometimes very bespoke, it can be difficult to say exactly how long it will take for data to be flowing in without a hitch. However, in our experience, as long as the respective dev teams meet ASAP and required fields are confirmed, this whole process should take approximately three weeks.
How do I get started?
1. First step is to understand how you want your data to look in the platform. If you already manually upload your data you'll likely have a template you can use to get started. If not, your CSM will support you to map out the fields you need.
2. Reach out to your IT/engineering team to book in time for them to complete the build. Introduce them to your CSM who can share all the information they'll need including credentials for a sandbox testing area, the data mapping document and the Wordnerds API documentation.
3. Your CSM will set up a call between the engineering teams from both parties and the platform user to review the results in the testing area. This is a chance to ask questions, address any queries and make sure the data is coming in the way we'd expect. Following that, your team should be able to connect to the main project and let the data start flowing in!
Clean it up 🧼 🫧 🧽
To get the most value out of the data you send to the Wordnerds Platform, it is best to clean it up before sending it. When you ask your technical team to integrate different data sources, you should work with them to ensure only the data you want to analyse is passed across. For more information see our article.
FAQs
Can I delete data that’s come through via API?
Yes, just send a request to the CSM with the project that you’d like the data to be deleted from as well as the segment of data you want deleted. We might need information like a reference ID or a date range.
Are there any limits on the length of brand/theme/header names?Yes, they cannot be longer than 191 characters.
Can I get historic data in via API too?Yes, ultimately you're in control of the data being sent. You may want to send data as soon as it becomes available or in batches at longer intervals. Speak with your Wordnerds CSM to discuss what will work best for you.
Our supplier wants Wordnerds to pull data from their software instead. Is this doable?Unfortunately not. Our Input API documentation is written so data providers/agencies push the data to us, rather than us writing bespoke code for each customer to pull data into the platform.
What happens if question wording and fields change?Data will stop coming into the platform until the question wording is changed within the API code.
✍️ Article written by: Lyndsay, Senior Customer Success Manager
Still in need of some help? Give us an email on support@wordnerds.ai or reach out to your CSM directly.