canonical: https://jentic.com/apis/googleapis.com/firebasedynamiclinks

# Google Firebase Dynamic Links API

The Firebase Dynamic Links API programmatically creates short and managed deep links that survive app installs and route users to specific content inside iOS and Android apps. It exposes endpoints to create short links, create managed short links with metadata, fetch click and install attribution, and retrieve aggregate link analytics. Use it to power referral campaigns, marketing emails, and social shares with deep links that work across web and native platforms.

## For AI agents

Generate Firebase Dynamic Links and retrieve install and click attribution so an agent can automate referral and deep-linking campaigns.

## Scope

Does not send push notifications, host web pages, or replace mobile attribution SDKs - use for generating deep links and reading link-level attribution only.

## Capabilities

- Generate a short Firebase Dynamic Link from a long URL with iOS and Android routing parameters
- Create managed short links with custom metadata for tracking marketing campaigns
- Retrieve install attribution showing which dynamic link drove a fresh app install
- Look up reopen attribution to see which dynamic link relaunched the app for an existing user
- Fetch event-level link statistics such as click and redirect counts for a dynamic link

## Use cases

### Referral Link Generation for Mobile Apps

Generate short Firebase Dynamic Links on demand for a referral programme so each invitation links back to the inviter and lands the new user on the right onboarding screen even if the app is freshly installed. POST /v1/shortLinks accepts a long deep-link URL and returns a shareable short link. Integration into an existing referral service takes a few hours.

Example prompt: Call POST /v1/shortLinks with longDynamicLink containing the iOS bundle, Android package, and deepLinkPath /onboarding?ref=USER123 and store the returned short link for sharing.

### Campaign-Tagged Managed Links

Create managed short links via POST /v1/managedShortLinks:create when you need editable metadata, naming, and ongoing analytics rather than fire-and-forget short links. Managed links keep their identity over time and are suited to long-running campaigns where the destination URL or campaign tag may change after the link is published.

Example prompt: Call POST /v1/managedShortLinks:create with name=summer_promo and a longDynamicLink that includes utm_campaign=summer to publish a managed link with built-in tracking metadata.

### Install and Reopen Attribution

Pull attribution data showing which dynamic link drove a specific install or reopen event using POST /v1/installAttribution and POST /v1/reopenAttribution. This lets growth teams measure the share of new users that came through deep links versus organic install paths, and reconcile mobile attribution with their analytics warehouse.

Example prompt: Call POST /v1/installAttribution with the bundleId and uniqueMatchLinkToCheck for an iOS install and inspect the returned attributionConfidence and matchType fields.

### Agent-Driven Referral Flows via Jentic

An AI agent using Jentic can generate dynamic links on the fly during a referral conversation and immediately track the resulting installs through the same provider. Jentic exposes the 5 Dynamic Links endpoints, the agent loads short-link generation and attribution endpoints, and OAuth credentials stay in your Jentic One instance rather than the agent context.

Example prompt: Through Jentic, search for generate a firebase dynamic short link, load the shortLinks.create operation, and execute it with longDynamicLink set to the deep link URL for the current user's referral.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/shortLinks | Create a short Firebase Dynamic Link |
| POST | /v1/managedShortLinks:create | Create a managed short Dynamic Link with metadata |
| POST | /v1/installAttribution | Retrieve install attribution for a dynamic link |
| POST | /v1/reopenAttribution | Retrieve reopen attribution for a dynamic link |
| GET | /v1/{dynamicLink}/linkStats | Get aggregated click and event stats for a dynamic link |

## Key resources

- **Short Links** — Create one-off short Firebase Dynamic Links from a long URL
- **Managed Short Links** — Create managed short links with persistent identity and metadata for long-lived campaigns
- **Install Attribution** — Retrieve attribution data for installs that came through dynamic links
- **Reopen Attribution** — Retrieve attribution data for app reopens triggered by dynamic links
- **Link Stats** — Read aggregated click and redirect stats for a given dynamic link

## Why Jentic

- **Setup:** Wiring the Firebase Dynamic Links API by hand means setting up Google OAuth 2.0 with a service account and building the short-link and attribution request payloads from Google's spec. Through Jentic you install once, import the Firebase Dynamic Links API from the API Directory, store the service-account credential once, and your agent calls it.
- **Permission scoping:** This API creates links from collection endpoints where the target travels in the request body (/v1/shortLinks, /v1/managedShortLinks:create), so scope the agent to the operations it needs, such as creating a short link or reading link stats. You choose that operation set, so attribution calls are not included unless you add them.
- **Credential handling:** Your Google service-account credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'generate a Firebase dynamic short link' or 'get dynamic link stats', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Firebase Hosting API** — Hosts the web fallback that Dynamic Links can route desktop users to.
- **Firebase Management API** — Sets up the Firebase project that owns Dynamic Links domains.
- **Firebase Cloud Messaging API** — Drives engagement via push notifications instead of click-through deep links.

## FAQ

### What authentication does the Firebase Dynamic Links API use?

The API uses Google OAuth 2.0 with the firebase or cloud-platform scope, typically supplied via a service account or installed application credential. Through Jentic the OAuth credentials live in your Jentic One instance and a scoped access token is added to each request transparently.

### Can I create a managed Firebase Dynamic Link with the Firebase Dynamic Links API?

Yes. POST /v1/managedShortLinks:create produces a managed short link with editable metadata such as name, suitable for marketing campaigns where the destination or campaign tags may change later. Use POST /v1/shortLinks for one-off non-managed links.

### What are the rate limits for the Firebase Dynamic Links API?

Google enforces standard googleapis.com project-level quotas for the Dynamic Links API. High-throughput campaign generation should batch creation requests and reuse the same managed link where possible rather than minting new links per share.

### How do I create a short dynamic link through Jentic?

Run pip install jentic, search for generate a firebase dynamic short link, load the shortLinks.create operation, and execute it with a longDynamicLink that includes the bundleId, packageName, and deepLinkPath. Get started with Jentic One, the self-hosted execution layer.

### Does the Firebase Dynamic Links API return deferred deep link attribution?

Yes. POST /v1/installAttribution returns the dynamic link parameters that survived an iOS or Android install, allowing the app to route a freshly installed user to the same destination they originally clicked.

### Is the Firebase Dynamic Links API free?

Firebase Dynamic Links is included with Firebase under standard usage limits. Note that Google has announced future deprecation of Dynamic Links - check the official Firebase documentation for the latest end-of-life timeline before building new dependencies.

### Can I limit what my agent is allowed to do with the Firebase Dynamic Links API?

Yes. Because you run Jentic One yourself, your own rules decide which Firebase Dynamic Links operations the agent may call and which Google service-account credential it may use. You can scope the agent to just link creation, such as POST /v1/shortLinks and POST /v1/managedShortLinks:create, or add read-only calls like the linkStats endpoint. Attribution operations such as POST /v1/installAttribution and POST /v1/reopenAttribution are only reachable if you include them in that operation set.
