GTM Motions

GTM Motions

The go-to-market motions of your organization and the gtmMotionId of each one

What a GTM motion is

A GTM (go-to-market) motion is one of the ways your organization goes to market, such as an online store and a B2B sales team. On the V4MOS.AI platform each motion groups its own connections and campaigns. One of the organization's motions is the default one.

Getting started

Base URL: https://data.v4mos.ai. Every call requires your API credentials and the organizationId — see Authentication. This endpoint takes the client credentials pair or a user token; a customer service account token gets 403.

  1. Call GET /v1/gtm-motions?organizationId=… and take the id of the motion you want.
  2. Send it as gtmMotionId to the analytics endpoints: Profitability, Products, Coupons, Forecast and E-commerce Summary.
FieldWhat it is
idThe value to send as gtmMotionId.
name / slugThe name given on the platform and its URL-friendly form.
gtmTypelead_gen, ecommerce, marketplace or loja_fisica (physical store). null when not set.
businessModelThe motion's business model. null when not set.
isDefaulttrue for the motion the endpoints answer for when gtmMotionId is omitted.

How the analytics endpoints use gtmMotionId

gtmMotionId is always optional. Without it, the response covers the organization's default GTM motion, so integrations that never send it keep working unchanged.

Only the default GTM motion has data for now

The analytics endpoints are not split by GTM motion yet. The default motion (or no gtmMotionId) answers with the organization's data, the same numbers as before; any other motion of the organization returns 422 with the code GTM_MOTION_DATA_NOT_AVAILABLE. A gtmMotionId that is not a UUID returns 400, and one that is not a motion of the organization returns 403 with the code GTM_MOTION_NOT_IN_ORGANIZATION, in the same body format as the 422, so you can tell it apart from a 403 of missing access.

An organization that has not set up its GTM motions yet gets an empty list, and the analytics endpoints answer for the whole organization.

Available endpoints

On this page