Gosquared

gosquared

GoSquared provides real-time web analytics and customer engagement tools to help businesses understand and interact with their website visitors.

Analytics Marketing Automation Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (43)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Shared UserGOSQUARED_ACCOUNT_ADD_SHARED_USERAcción

Tool to add a new shared user to a project. Use when inviting team members via their email address.

Parámetros de entrada

rolestringenum
Role assigned to the user. Accepted values: 'admin' or 'member'.
adminmember
emailstringObligatorioemail
Email address of the user to add.
notifyboolean
Whether to send an invite email to the user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove shared userGOSQUARED_ACCOUNT_REMOVE_SHARED_USERAcción

Tool to remove a user from a GoSquared project. Use when you need to revoke a shared user's access to your site.

Parámetros de entrada

emailstringObligatorioemail
Email address of the user to remove from the project.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Account Shared UsersGOSQUARED_ACCOUNT_SHARED_USERSAcción

Tool to retrieve all team members that have access to a given project. Use after specifying the project to inspect user access.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Account SitesGOSQUARED_ACCOUNT_SITESAcción

Tool to list all projects/sites accessible to the authenticated account. Use when you need to retrieve the account's sites in either grouped or flat format.

Parámetros de entrada

callbackstring
Function name to wrap the JSONP response; only used when requesting JSONP.
presenterstringenum
Modifies response structure: 'grouped' returns sites grouped by ownership; 'flat' returns all accessible sites.
groupedflat

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Check API Token Validity and ScopesGOSQUARED_AUTH_TOKEN_INFOAcción

Tool to check whether an API key is valid and retrieve its enabled scopes. Use when verifying API credentials before making further API calls.

Parámetros de entrada

api_keystringObligatorio
An API Key associated with your account.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Chat ConversationGOSQUARED_CHAT_CHATAcción

Tool to retrieve a chat conversation by its ID. Use when you need the full conversation history after obtaining a chat session ID.

Parámetros de entrada

chatIDstringObligatorio
The ID of the chat conversation (same as the person_id of the client).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Chat MessagesGOSQUARED_CHAT_CHAT_MESSAGESAcción

Tool to retrieve a list of messages from a chat conversation. Use after identifying the chatID via listing chat conversations to page through a chat's message history.

Parámetros de entrada

limitstring
Pagination offset and count, formatted as 'offset,count'. Max count is 250.
chatIDstringObligatorio
The ID of the chat conversation (same as the person's person_id).
to_datestring
End date-time for the query, in ISO 8601 format.
from_datestring
Start date-time for the query, in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Chat ConversationsGOSQUARED_CHAT_CHATSAcción

Tool to retrieve chat data for reporting purposes. Use when you need to list active chat conversations within a specific time window.

Parámetros de entrada

limitstring
Pagination offset and count, formatted as 'offset,count'. Max count is 250.
to_datestring
End date-time for the query, in ISO 8601 format.
from_datestring
Start date-time for the query, in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Chat FeedGOSQUARED_CHAT_FEEDAcción

Tool to retrieve messages and events from a chat conversation. Use when you need to fetch chat history for a specific chat session.

Parámetros de entrada

limitstring
Pagination offset and count formatted as 'offset,count'. Max count is 250.
chat_idstringObligatorio
ID of the chat conversation (same as the client person_id)
to_datestring
End date-time for the query in ISO 8601 format.
from_datestring
Start date-time for the query in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete personGOSQUARED_DELETE_PERSONAcción

Tool to delete a person profile and all associated data. Use when you need to permanently remove a person's record and optionally blacklist them.

Parámetros de entrada

blacklistboolean
If true, blacklist the person's IDs/emails to block re-creation, outbound sends, and webhooks.
person_idstringObligatorio
Unique identifier of the person to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get specific chat messageGOSQUARED_GET_CHAT_CHAT_MESSAGEAcción

Tool to retrieve a specific chat message. Use when you have both chat ID and message ID to fetch the message details.

Parámetros de entrada

chat_idstringObligatorio
ID of the chat conversation containing the message.
message_idstringObligatorio
ID of the message to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Specific VisitorGOSQUARED_GET_NOW_VISITORAcción

Tool to retrieve information for a specific online visitor. Use after obtaining visitorID to get detailed visit data.

Parámetros de entrada

limitstring
Maximum results; optional offset as 'offset,count' (e.g., '5,10').
presenterstringenum
Response presentation mode: 'plain', 'events', or 'pageEvents'.
plaineventspageEvents
visitorIDstringObligatorio
The unique ID of the visitor to retrieve.
visitorsModestringenum
Filter visitors by type: 'all', 'tagged', or 'returning'.
alltaggedreturning

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get People Event TypesGOSQUARED_GET_PEOPLE_EVENT_TYPESAcción

Tool to retrieve event types ordered by tracked count. Use when you need to display the most tracked event types.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get People Property TypesGOSQUARED_GET_PEOPLE_PROPERTY_TYPESAcción

Tool to retrieve all property types in People CRM. Use when you need to discover available profile or event properties.

Parámetros de entrada

custom_onlyboolean
Return only custom properties (GET /people/v1/propertyTypes/custom)
property_idstring
Property identifier to fetch (GET /people/v1/propertyTypes/{property_id})

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PersonGOSQUARED_GET_PERSONAcción

Tool to retrieve a specific person profile by ID. Use when you need to fetch details of a person by their unique identifier.

Parámetros de entrada

person_idstringObligatorio
Unique identifier of the person to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

GoSquared - Get Person FeedGOSQUARED_GET_PERSON_FEEDAcción

Tool to retrieve a specific person's event feed in reverse chronological order. Use after confirming the personID.

Parámetros de entrada

sortstring
Sort order, e.g., 'ts:desc' (newest first) or 'ts:asc'.
typestring
Comma-separated event families to include: 'event' for custom events and 'sessionEvent' for GoSquared session events.
limitstring
Pagination in the form 'offset,count'. Offset ≥ 0; count ≤ 250 per request.
querystring
Search within the person's event history by event name.
to_timestring
End ISO 8601 date-time for the feed filter.
personIDstringObligatorio
The unique identifier of the person whose event feed to retrieve.
from_timestring
Start ISO 8601 date-time for the feed filter.

Parámetros de salida

dataobject[]Obligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List PeopleGOSQUARED_LIST_PEOPLEAcción

Tool to search and filter People CRM profiles. Use when you need to retrieve a list of people based on query terms, specific property or event filters, sorting, and pagination.

Parámetros de entrada

sortstring
Property to sort by with direction suffix ':asc' or ':desc' (default 'last.seen:desc').
limitstring
Maximum results to return; may include offset as 'offset,count' (e.g., '0,10'). Max 250.
querystring
Free-text search term to filter people profiles.
fieldsstring
Comma-separated list of fields to return for each person (e.g., 'id,email').
filtersobject[]
List of filter objects to apply on properties or events.
presenterstringenum
Response format: 'plain' for JSON array, 'csv' for CSV text (default 'plain').
plaincsv
dateFormatstring
Moment.js format string for any date fields in the response.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get current concurrent visitorsGOSQUARED_NOW_CONCURRENTSAcción

Tool to retrieve the number of concurrent visitors currently on your site. Use when you need live, real-time visitor metrics.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Real-Time Popular PagesGOSQUARED_NOW_PAGESAcción

Tool to retrieve the most popular pages currently being viewed on your site. Use when real-time active page data is needed.

Parámetros de entrada

hrefstring
Full URL of the page to filter by (must be URL-encoded).
limitstring
Maximum results to return or offset,count (e.g., '5,10').

Parámetros de salida

dataobject[]Obligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Real-Time Visitor PlatformsGOSQUARED_NOW_PLATFORMSAcción

Tool to retrieve platforms used by online visitors sorted by visitor count. Use when you need a real-time breakdown of active visitor platforms.

Parámetros de entrada

limitstring
Maximum number of results to return; may include offset as 'offset,count' (e.g., '5,10').
presenterstringenum
Alters response shape; one of: 'truncatedList', 'list', 'truncatedObject', 'object'.
truncatedListlisttruncatedObjectobject

Parámetros de salida

dataobject[]Obligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Real-Time OverviewGOSQUARED_NOW_V3_OVERVIEWAcción

Tool to retrieve a summary of real-time data for the site. Use when a snapshot of current online visitor metrics and summary statistics is needed.

Parámetros de entrada

to_datestring
End date-time for the query in ISO 8601 or any Moment.js-compatible format.
from_datestring
Start date-time for the query in ISO 8601 or any Moment.js-compatible format.
dateFormatstring
Format for returned date fields; accepts any Moment.js format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Now SourcesGOSQUARED_NOW_V3_SOURCESAcción

Tool to retrieve the most influential traffic sources currently driving visitors to your site. Use when you need an up-to-the-minute breakdown of referrer sources.

Parámetros de entrada

limitstring
Maximum results to return; may include offset as "offset,count" (e.g., "5,10").
minimalboolean
If true, returns a compacted version of the response.
sectionsstring
Comma-separated list of source types to include.
drillLimitstring
Maximum drill-down results per section; may include offset as "offset,count" (e.g., "0,5").

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Time SeriesGOSQUARED_NOW_V3_TIME_SERIESAcción

Tool to retrieve visitor counts over time as data points. Use when you need historical visitor data bucketed by interval.

Parámetros de entrada

to_timestring
End date-time of the query window in ISO 8601 format.
intervalstring
Discrete bucket size in minutes, format 'Xmin' (e.g., '5min'). Default '5min'.
from_timestring
Start date-time of the query window in ISO 8601 format, e.g., '2021-01-01T00:00:00Z'.
dateFormatstring
Moment.js format string for any returned dates.

Parámetros de salida

dataobject[]Obligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Real-Time Online VisitorsGOSQUARED_NOW_VISITORSAcción

Tool to retrieve a list of current online visitors. Use when you need detailed real-time visitor information.

Parámetros de entrada

limitstring
Maximum results to return; supports 'offset,count' (e.g., '5,10').
to_datestring
End date-time for the query window (ISO-8601).
from_datestring
Start date-time for the query window (ISO-8601).
dateFormatstring
Moment.js format string for returned date fields.
visitorsModestringenum
Subset of visitors to return; one of 'all', 'tagged', or 'returning'.
alltaggedreturning

Parámetros de salida

dataobject[]Obligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

GoSquared - People DevicesGOSQUARED_PEOPLE_DEVICESAcción

Tool to retrieve device information from People CRM. Use when you need a paginated view of a user's device usage.

Parámetros de entrada

limitstring
Pagination in the form 'count' or 'offset,count'. Default '0,10'. Maximum count per page is 250.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Export Smart Group FeedGOSQUARED_PEOPLE_SMARTGROUP_FEEDAcción

Tool to export all pageview activity for a Smart Group to CSV. Use when you need a temporary download link for up to 60 days of data; link expires after 15 minutes.

Parámetros de entrada

to_datestring
End date-time (ISO 8601) to filter the export. Max 60-day range.
group_idstringObligatorio
ID of the Smart Group to export the pageview feed.
from_datestring
Start date-time (ISO 8601) to filter the export. Max 60-day range.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Smart Group PeopleGOSQUARED_PEOPLE_SMARTGROUP_PEOPLEAcción

Tool to retrieve people in a specific Smart Group. Use when listing or filtering members of a Smart Group.

Parámetros de entrada

sortstring
Sort order '<property>:asc' or '<property>:desc'.
limitstring
Pagination as 'offset,count'; count must be between 0 and 250.
querystring
Search term to filter members of the Smart Group.
fieldsstring
Comma-separated list of fields to return (e.g., 'id,email').
group_idstringObligatorio
ID of the Smart Group.
presenterstringenum
Response format: 'plain' for JSON or 'csv' for CSV output.
plaincsv
dateFormatstring
Moment.js format string for date fields.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List People SmartGroupsGOSQUARED_PEOPLE_SMART_GROUPSAcción

Tool to retrieve all Smart Groups for a project. Use when you need to list the Smart Groups configured in your People project.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Account SiteGOSQUARED_POST_ACCOUNT_SITESAcción

Tool to add a new site to the GoSquared account. Use when you want to register a new site for data collection under your account.

Parámetros de entrada

urlstringObligatorio
Publicly accessible site URL to track (must start with http:// or https://).
namestring
Display name for the new site (optional).
timezonestring
IANA timezone for the site (server default: Europe/London).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Archive Chat ConversationGOSQUARED_POST_CHAT_CHAT_ARCHIVEAcción

Tool to archive a chat conversation. Use when you need to programmatically close out a chat after its session ends.

Parámetros de entrada

chatIDstringObligatorio
ID of the chat to archive (same as the person_id of the client).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send Chat MessageGOSQUARED_POST_CHAT_CHAT_MESSAGEAcción

Tool to send a message in a chat conversation. Use after confirming chatID and providing auth if sending as client.

Parámetros de entrada

authstring
Person Signature for client messages; required when sending as client.
chatIDstringObligatorio
ID of the chat conversation (same as the person's person_id).
senderstringenum
Source of the message; one of: agent, client, bot.
agentclientbot
contentstringObligatorio
Message text content
timestampinteger
Epoch seconds timestamp for the message.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Leave Chat NoteGOSQUARED_POST_CHAT_CHAT_NOTEAcción

Tool to leave a note in a chat conversation. Use when you need to annotate or add comments to an existing chat session.

Parámetros de entrada

chatIDstringObligatorio
The ID of the chat conversation (same as the person_id of the client).
senderstringenum
Sender type of the note. Accepted values: 'agent', 'client', or 'bot'.
agentclientbot
contentstringObligatorio
The text content of the note.
timestampinteger
Unix timestamp of the note.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unarchive Chat ConversationGOSQUARED_POST_CHAT_CHAT_UNARCHIVEAcción

Tool to unarchive a chat conversation. Use when you need to restore an archived chat back to active state after confirming that the conversation should be resumed.

Parámetros de entrada

chatIDstringObligatorio
ID of the chat to unarchive (same as the person_id of the client).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create People SmartGroupGOSQUARED_POST_PEOPLE_SMARTGROUPSAcción

Tool to add a new Smart Group to a GoSquared project. Use when you need to segment users by custom criteria.

Parámetros de entrada

namestringObligatorio
Name of the Smart Group
prefsobject
Optional preferences for the Smart Group
filtersobject[]Obligatorio
List of filter objects defining group membership
sortDirstringenum
Sort direction, either 'asc' or 'desc'
ascdesc
sortFieldstring
Field to sort members by

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track GoSquared EventGOSQUARED_TRACKING_EVENTAcción

Tool to send custom events to GoSquared. Use when tracking user or system events in analytics.

Parámetros de entrada

ipstring
Visitor IP to detect location.
pageobject
Page context with keys: url, title, previous, index.
eventobjectObligatorio
Event object with name (required), data (optional), timestamp (optional)
totalobject
Totals context (visits, pageviews).
screenobject
Screen context (height, width, pixel_ratio, depth).
campaignobject
Campaign context (name, source, medium, content, term).
languagestring
Language setting of the visitor's browser.
locationobject
Location context (timezone_offset).
referrerstring
Referrer URL.
person_idstring
Person ID for this event; prefix with 'email:' if using email.
returningboolean
Whether the visitor is returning.
user_agentstring
User agent string of the visitor's browser.
visitor_idstring
Anonymous visitor ID associated with the event.
character_setstring
Character set of the visitor's browser.
last_pageviewstring
ISO 8601 timestamp of last pageview.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track GoSquared IdentifyGOSQUARED_TRACKING_IDENTIFYAcción

Tool to identify users and associate them with specific properties in GoSquared. Use after obtaining or confirming a visitor’s identity to link their anonymous activity with their known user record and update their profile.

Parámetros de entrada

person_idstringObligatorio
Unique identifier for the person; prefix with 'email:' if using email address.
propertiesobject
Additional properties to set for the identified person.
visitor_idstring
Anonymous visitor ID to associate with this person.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track PageviewGOSQUARED_TRACKING_PAGEVIEWAcción

Tool to track pageviews. Use when you need to record a pageview event for a visitor after obtaining their visitor_id and page details.

Parámetros de entrada

ipstring
Visitor IP address (used for geolocation)
pageobjectObligatorio
Information about the page being viewed
totalobject
Aggregate visit and pageview counts for the visitor.
screenobject
Screen properties of the visitor.
campaignobject
Campaign data for pageview.
languagestring
Browser language
locationobject
Visitor location information.
referrerstring
Referrer URL
returningboolean
Whether the visitor has returned before
timestampstring
ISO 8601 timestamp of this pageview
user_agentstring
Browser user-agent string
visitor_idstringObligatorio
Anonymous visitor ID for this action
character_setstring
Browser character set
last_pageviewstring
ISO 8601 timestamp of last pageview

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Track GoSquared TransactionGOSQUARED_TRACKING_TRANSACTIONAcción

Tool to track e-commerce transactions. Use when a user completes a purchase and you need to record the transaction in GoSquared.

Parámetros de entrada

ipstring
Visitor IP address for geolocation.
pageobject
Page context with keys: url, title, previous, index, referrer.
totalobject
Session totals with keys: visits, pageviews.
screenobject
Screen context with keys: height, width, pixel_ratio, depth.
campaignobject
Campaign context with keys: name, source, medium, content, term.
languagestring
Language setting of the visitor's browser.
locationobject
Location context with key: timezone_offset.
person_idstring
People person ID; prefix with 'email:' when using email.
returningboolean
Whether the visitor is returning.
timestampstring
ISO 8601 timestamp of when the transaction occurred.
user_agentstring
User agent string of the visitor's browser.
visitor_idstring
Anonymous visitor ID associated with this transaction.
transactionobjectObligatorio
Transaction payload with keys: id, revenue, quantity, previous_transaction_timestamp, items.
character_setstring
Character set of the visitor's browser.
last_pageviewstring
ISO 8601 timestamp of last pageview.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Aggregate MetricsGOSQUARED_TRENDS_AGGREGATEAcción

Tool to retrieve aggregate metrics for a specified period. Use after specifying both start and end date-times to obtain summarised metrics, optionally grouped by interval.

Parámetros de entrada

limitstring
Pagination limit as 'offset,count'. Default is '0,20'.
formatstringenum
Response format, overrides Accept header.
jsoncsv
to_datestringObligatorio
End date-time for the query in ISO 8601 format.
intervalstringenum
Aggregation interval for grouping data.
hourdaymonth
from_datestringObligatorio
Start date-time for the query in ISO 8601 format.
dateFormatstring
Moment.js format string for any date fields in the response.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Campaign Medium MetricsGOSQUARED_TRENDS_CAMPAIGN_MEDIUMAcción

Tool to retrieve UTM medium metrics over a time period. Use when analyzing campaign performance by medium.

Parámetros de entrada

to_datestringObligatorio
End date-time for the query in ISO 8601 format.
from_datestringObligatorio
Start date-time for the query in ISO 8601 format.
resolutionstringenum
Aggregation bucket size for the time-series data.
hourdayweekmonth

Parámetros de salida

dataobject[]Obligatorio
List of UTM mediums and their time-series data.
metaobjectObligatorio
Time period and resolution information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Event CountsGOSQUARED_TRENDS_EVENTAcción

Tool to retrieve counts of event triggers over a specified time period. Use when you need to analyze event frequency for a site between two date-times.

Parámetros de entrada

limitstring
Pagination limit as 'offset,count'. Default is '0,20'.
formatstringenum
Response format, overrides Accept header.
jsoncsv
to_datestringObligatorio
End date-time for the query in ISO 8601 format.
from_datestringObligatorio
Start date-time for the query in ISO 8601 format.
dateFormatstring
Moment.js format string for any date fields in the response.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Page MetricsGOSQUARED_TRENDS_PAGEAcción

Tool to retrieve page-level metrics over a specified period. Use when you want summarised page metrics for individual pages within a date range.

Parámetros de entrada

limitstring
Limit results with optional offset,count (e.g., '0,20').
formatstringenum
Response format; 'json' (default) or 'csv'.
jsoncsv
to_datestringObligatorio
End date-time for the query, in ISO 8601 format.
from_datestringObligatorio
Start date-time for the query, in ISO 8601 format.
dateFormatstring
Moment.js format string for output dates.

Parámetros de salida

dataobject[]Obligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Base Path MetricsGOSQUARED_TRENDS_PATH1Acción

Tool to retrieve base path metrics over a time period. Use when you need to analyze the most common entry page paths for a site within a specified date range.

Parámetros de entrada

limitstring
Limit results with optional 'offset,count' (e.g., '0,20').
formatstringenum
Response format; 'json' (default) or 'csv'.
jsoncsv
to_datestringObligatorio
End date-time for the query, in ISO 8601 format.
from_datestringObligatorio
Start date-time for the query, in ISO 8601 format.
dateFormatstring
Moment.js format string for output dates.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not