MyAPI™

This article contains instructions for setting up KickFire’s MyAPI and provides additional steps for configuring with your KickFire for Google or Adobe integration.

MyAPI allows you to combine your custom first-party data attributes to personalize KickFire’s Company API response for a specified set of accounts. Segment, filter, and combine important "known" data, such as Account Watchlist, Account Tier, Sales Agent, Sales Territory, and more to meet your team's needs.

 

Preparing Your MyAPI Data File

KickFire MyAPI Setup & Upload

Configure KickFire for Google MyAPI Fields

Configure KickFire for Adobe MyAPI Fields

Refreshing Your MyAPI Data File

 

Preparing Your MyAPI Data File

  • The first column must be the company domain and should NOT include any https://, www, page names, or trailing URL data. (Example: acme.com)
  • The subsequent 10 column headers will contain your custom data fields. (Example: watchlist, accountOwner, accountTier)
  • All 10 column headers must be present, even if empty.
  • Any fields that contain a comma must be enclosed by double-quotes. (Example: “Customers, Upsell List”)
    myapi-1
  • Save as a .csv file. Your .csv file should look like this:
    myapi-2

KickFire MyAPI Setup & Upload

  1. Log in to KickFire API
    Need help creating an API key? Refer to Getting Started with KickFire API
  2. Select the API key that matches your MyAPI data file.
  3. Under the MyAPI tab, enter your MyAPI field label names to match your data file. Click Save Fields.
  4. Click Upload File to upload your MyAPI data file.
    myapi-3
  5. Your MyAPI setup is complete. Continue on to configure your Google & Adobe integration.

Configure KickFire for Google MyAPI Fields

Be sure you have completed the KickFire for Google setup in Google Analytics and Google Tag Manager. Need help? Refer to KickFire for Google Setup Guide.

  1. In Google Analytics, navigate to Admin > Custom Definitions > Custom Dimensions.
  2. Click Add New Custom Dimension and name it to match the MyAPI fields. Select Session, check Active, and click Create. Repeat as needed for all MyAPI field labels.
    myapi-4
    Take note of the Index numbers. In Step 7, you will associate the Index number assigned in Google Analytics to the Custom Dimensions field created in Google Tag Manager.
  3. Within Google Tag Manager, click on Tags and select KickFire API Call.
  4. In the HTML textbox, scroll to find the line that says: 'myapi_call': 'false', Within the single quotes, replace false with true and click Save.
    myapi-5
  5. Create a new KickFire API Return variable by clicking on Variables > New.
  6. Choose Data Layer Variable and name the variable in the same format as in the MyAPI tab of your KickFire reporting environment. Click Save.
  7. Click Tags > KickFire API Event - Success - all fields. Add the appropriate MyAPI Custom Dimensions (matching Index Number and Variable Name from Google Analytics).
  8. Your KickFire MyAPI configuration into Google is complete!

Configure KickFire for Adobe MyAPI Fields

Be sure you have completed the KickFire for Adobe setup in Adobe Launch.
Need help? Refer to KickFire for Adobe Setup Guide.

  1. In Adobe Launch, navigate to the KickFire Extension.
  2. Toggle ‘Get MyAPI Data’ to the ON position and ‘Keep Data if ISP’ to the OFF position. Click Save.
    myapi-6
  3. Click Data Elements > Add Data Element.
  4. Name the Data Element to match the MyAPI fields. Set Extension to KickFire and Data Element Type to MyAPI.
    myapi-7
  5. In the configuration screen, enter the custom KickFire data value to be mapped to the Adobe Launch data element based on your MyAPI field labels from KickFire MyAPI Setup & Upload Step 2.
    myapi-8
  6. Your KickFire MyAPI configuration into Adobe is complete!

Refreshing Your MyAPI Data File

Work with your team on the cadence of updating. Most teams update on a weekly, monthly, or quarterly basis. For questions, please contact our Customer Success & Support team.