Skip to docs navigation

SegMetrics integration guide

Verified

How to connect SegMetrics to WEXTL and use its 16 actions in your workflows. About SegMetrics: Marketing attribution: send contacts, tags, purchases, subscriptions and ad spend to SegMetrics and pull report data and contact journeys.

  • 4 searches
  • 12 actions
  • Polling
  • Auth: API key

AI-assisted documentation6 min read

This documentation is compiled from our integration source code, internal specs for SegMetrics, its official API documentation and anonymized requests logs we collect from our support team[2].

Open SegMetrics on WEXTL →
  • SegMetrics
  • WEXTL
  • WhatConverts
  • ActivTrak
  • The Official Board
  • Playvox
  • Databox
  • Grafana
  • Klipfolio
  • ProfitWell
  • Mixpanel
  • Chameleon
  • Faraday
  • GoSquared
  • Userflow
  • Feedly
  • Gigasheet
  • Metabase
  • Ignition Reporting
  • Microsoft Reports
  • Monitask
  • Microsoft Power BI
  • Tableau
  • Account IDtextRequired

    In SegMetrics open Account, then API. Copy the Account API ID.[1]

  • API KeypasswordRequired

    On the same Account page. It is sent exactly as shown, with no prefix.[1]

  1. Log in to your WEXTL account, add the SegMetrics node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your SegMetrics account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Get a Contact

SearchOne contact with name, Email and Status.
Input fields[3]
FieldType
Contact ID or EmailRequired
text
Extendchoice
Output fields[3]
FieldType
Contact IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Date Createddate
Last Updateddate
Custom Fieldsobject
Citytext
Tagsarray

Get Report Data

SearchFigures for a saved or standard report between two dates.
Input fields[3]
FieldType
Report TypeRequired
choice
Saved Report IDtext
Starttext
Endtext
Scalechoice
Output fields[3]
FieldType
Reportobject
Nametext
Typetext
Date Rangeobject
Kpisarray
Graphobject
Labelsarray
Datasetsarray
Tableobject
Fieldsarray
Rowsarray

List Report Contacts

SearchCustomer journeys behind one report, filtered by Report Type.
Input fields[3]
FieldType
Report TypeRequired
choice
Saved Report IDtext
Starttext
Endtext
Extendchoice
Limitnumber
Output fields[3]
FieldType
Contact IDtext
First Nametext
Last Nametext
Emailtext
Statustext
Date Createddate
Last Updateddate
Custom Fieldsobject
Citytext
Tagsarray

Run a Report Query

SearchAd-hoc report rows and totals for a Type.
Input fields[3]
FieldType
TypeRequired
text
Dimensionsarray
Metricsarray
Starttext
Endtext
Scalechoice
Filterstext
Stepstext
Comparetext
Optionstext
Output fields[3]
FieldType
Typetext
Fieldsarray
Rowsarray
Totalsarray
Date Rangeobject
Start Datetext
End Datetext
Scaletext
Comparisontext
Vtext

Add a Purchase to a Contact

ActionInvoice figures and line items attached to one contact.
Input fields[3]
FieldType
Integration IDRequired
text
Invoice IDRequired
text
TotalRequired
number
Amount PaidRequired
number
Purchase DateRequired
date
ItemsRequired
array
Itemobject
Contact IDtext
Emailtext
Refundedboolean
Discountnumber
Taxnumber
Shippingnumber
Output fields[3]
FieldType
Statustext

Add an Ad Performance Record

ActionDay-level ad cost and traffic figures for a custom integration.
Input fields[3]
FieldType
Integration IDRequired
text
Ad IDRequired
text
SpendRequired
number
DateRequired
date
Clicksnumber
Impressionsnumber
Ad Nametext
Ad Campaign IDtext
Ad Campaign Nametext
Ad Set IDtext
Ad Set Nametext
Output fields[3]
FieldType
Statustext

Add Tags to a Contact

ActionAdds labels to a contact without clearing old ones.
Input fields[3]
FieldType
Integration IDRequired
text
TagsRequired
array
Contact IDtext
Emailtext
Tag Objectsarray
Tagobject
Output fields[3]
FieldType
Statustext

Create or Update a Contact

ActionContact record with attribution fields.
Input fields[3]
FieldType
Integration IDRequired
text
Contact IDtext
Emailtext
First Nametext
Last Nametext
Statuschoice
Date Createddate
Last Updateddate
UTM Sourcetext
UTM Mediumtext
UTM Campaigntext
UTM Contenttext
UTM Termtext
Referring URLtext
Optin URLtext
IP Addresstext
Affiliate IDtext
Geographic Latitudetext
Geographic Longitudetext
Tagsarray
Tagobject

3other input fields

Output fields[3]
FieldType
Statustext

Create or Update a Product

ActionProduct record keyed by your own ID.
Input fields[3]
FieldType
Integration IDRequired
text
Product IDRequired
text
NameRequired
text
Output fields[3]
FieldType
Statustext

Create or Update a Subscription

ActionRecurring billing plan for a contact.
Input fields[3]
FieldType
Integration IDRequired
text
Subscription IDRequired
text
AmountRequired
number
Product IDRequired
text
Start DateRequired
date
Last Bill DateRequired
date
Billing CycleRequired
choice
FrequencyRequired
number
Contact IDtext
Emailtext
Product Nametext
Quantitynumber
Trial End Datedate
End Datedate
Canceled Datedate
Output fields[3]
FieldType
Statustext

Delete a Contact

ActionPermanent removal of a contact record.
Input fields[3]
FieldType
Integration IDRequired
text
Contact ID or EmailRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Delete a Purchase

ActionPermanent removal of an invoice.
Input fields[3]
FieldType
Integration IDRequired
text
Invoice IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Delete a Subscription

ActionPermanent removal of a subscription.
Input fields[3]
FieldType
Integration IDRequired
text
Subscription IDRequired
text
Output fields[3]
FieldType
IDtext
Deletedboolean

Make an API Call

universalFree-form SegMetrics REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Remove Tags from a Contact

ActionClears labels from a contact in SegMetrics.
Input fields[3]
FieldType
Integration IDRequired
text
TagsRequired
array
Contact IDtext
Emailtext
Tag Objectsarray
Tagobject
Output fields[3]
FieldType
Statustext

Send a Visitor Identity

ActionIdentifies who a tracked website visit belongs to.
Input fields[3]
FieldType
Emailtext
Contact IDtext
Session UIDtext
Output fields[3]
FieldType
Successboolean
Emailtext
Contact IDtext
Session UIDtext

Look for SegMetrics templates in the WEXTL template library.

Browse templates →
  1. WEXTL® SegMetrics Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for SegMetrics.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.