Deep Link Generator API
The Deeplink Generator API is available for customers with TrueLink Core and TrueLink Enterprise plans. Reach out to sales@adjust.com to upgrade now.
The Deep Link Generator (DLG) API allows you to create and manage Adjust deep links programmatically. Instead of manually generating links in the Adjust dashboard, you can use the API to build flexible and scalable link-generation workflows that support single or bulk link creation.
- Scale link creation by automating generation through APIs instead of manual workflows
- Integrate deep link generation into your existing tools, such as CRM systems or campaign management platforms
- Create and manage short or long links individually or in bulk
- Build custom link-generation dashboards or scripts for internal use cases
What it does
The DLG API replicates the functionality of the Adjust Deep Link Generator, giving you programmatic control over link creation. You can:
- Generate single or multiple deep links in one request.
- Create short or long links depending on your campaign needs.
- Update existing short links tokens.
- Build tools or workflows that connect directly to Adjust’s automation endpoints.
Using the API, teams can automate repetitive link-creation processes and maintain accuracy and consistency in campaign measurement.
Use cases
How does it work?
The DLG API uses HTTPS requests to Adjust automation endpoints. All calls are authorized using your existing Adjust API token.
Endpoints overview:
- Generate a single deep link: POST
https://automate.adjust.com/engage/deep-links - Generate deep links in bulk: POST
https://automate.adjust.com/engage/deep-links/bulk - Update a short link token: PUT
https://automate.adjust.com/engage/deep-links/{short_token} - Retrieve Short link data: GET
https://automate.adjust.com/engage/deep-links/short-link?short_token={short_token}&app_token={app_token}
Get started
Requirements
- TrueLink Core or TrueLink Enterprise package.
- A branded domain for both iOS and Android
- Adjust API token with Deep Link Generator API access.
Setup summary
- Configure your branded domain for iOS and Android.
- Obtain your Adjust API token and link token.
- Build and test API calls, following the Adjust developer documentation.
- Integrate automation scripts or macros to generate links at scale.
For complete details on how to get started, use the official Adjust Developer Documentation guide to the Deep Link Generator API.
Best practices
- Keep your Adjust SDK updated to ensure compatibility with short link resolution.
- Use bulk endpoints for large campaigns to avoid rate-limit issues (max 200 requests/second).
- Store campaign metadata centrally and automate link creation via macros or scripts.
- Validate API responses and retry failed requests.
- Use one branded domain for both platforms for consistent redirects.
- Keep API tokens secret and rotate periodically for security.
Usage reporting and monitoring
The Deep Link Generator API includes quota limits for short link creation. You can monitor usage through the Adjust dashboard and API responses.
Short link quota
- Short link limits apply at the account level
- Limits are based on the number of unique short tokens generated
- Identical requests will return existing links, and do not increase usage
What counts toward the limit
The quota applies only to:
- Short links created via the API
The quota does not apply to:
- Long links
- Short links created via the dashboard
View usage in the Adjust dashboard
You can view usage data in the Adjust Suite:
- Go to Account settings
- Select Plans & Usage
This section displays:
- Total short link quota
- Remaining short links
- Contract details
If you wish to view the usage data in Datascape, change date ranges, and view split in usage by different apps, you may also use this direct link
View usage via API headers
Each API response includes headers with quota and contract information. To know more about API payload structure, check Deep Link Generator Documentation on the Developer Hub
Following are the headers:
x-shortlink-quota-limit
x-shortlink-quota-remaining
x-contract-status
x-contract-start-date
x-contract-end-date