Skip to content
English
  • There are no suggestions because the search field is empty.

How To: Install Admiral (API)

Step-By-Step Guide to API Installation of Admiral

NOTE: Websites hosted on WordPress should use the Admiral WordPress Plugin located HERE.

1) The Admiral install script can be found on the Install Tab of your Admiral Dashboard.

Screenshot 2025-04-03 at 1.28.43 PM

2) The install script should be pulled, cached server side, and then injected directly into the <head> tag on page.

3) The cache expiry duration should be set so as to prevent the Install API URL from being referenced directly for each pageview. Admiral recommends the expiry duration be set for one (1) hour.

**Keep in mind that the cache expiry duration will determine how long it takes the tag to change.**

4) Once your tag is installed, your analytics will begin to populate within an hour.

image-1

Frequently Asked Questions

I just installed Admiral on my site. Why am I not seeing an Admiral message?

Have you created a journey and turned it on? You will not see an Admiral engage message until you create and activate a journey. For more guidance, here is an article on creating a journey

I just installed Admiral, what should I do next?

How do I know I performed the API Installation correctly?

Connect with your Admiral Account Manager who will be able to confirm successful installation. If you are unsure of your Account Manager, please email <support@getadmiral.com>. 

Click on the links below to help you get started. 

Next steps: 

Dashboard overview

How to create an offer

How to create a journey

How to create an engage message

How often should my messages appear to visitors?