Magidoc

Query
Object

Query operations for retrieving journey nodes and related information.

Fields

#

aIRequest

account

accountApiKey

accountAutoRetryRule

accountIntegration

Return a specific account integration

accountInvoice

accountInvoices

accountMonthlyGrowthStats

accountPaymentMethod

accountSuppressionFilter

accountSuppressionFilters

affiliateAccountStatsByDay

Number of accounts by day for a given month

affiliateAccounts

Get a list of accounts associate associated with the logged in affiliate

affiliatePayment

Non-null

Get affiliate payment

affiliatePayments

Get affiliate payments

affiliateStats

Non-null

Get a list of accounts associate associated with the logged in affiliate

allAIRequests

allAccountApiKeys

allAccountEntities

allAccountIntegrations

Return a list of account integrations. Integration partner information is not included.

allAccountPlanStats

allAccountPlans

allCampaignBounceTypeByDomainStats

allCampaignBounceTypeStats

allCampaignCombinationStats

allCampaignContactEventTypeStats

SortColumn can be set to 'emailaddr', 'logcount', 'email', or 'events'.

allCampaignDeviceStats

allCampaignLinkStats

Non-null

allCampaignSocialShareStats

allCampaignSoftwareStats

allCustomReports

allExports

allIntegrationPartners

Return a list of integrations

allPlans

allSyncJobs

Get all sync jobs for an account

allTransactions

allUserActivity

allUserNotifications

allWebhooks

article

articleContent

Non-null

artitelliBalance

audience

audienceCampaignImpact

Get campaign engagement impact analysis for an audience

audienceDataField

audienceDataFieldCategories

audienceDataFields

audienceExport

audienceExports

audienceGroup

audienceGroups

audienceHealth

Get audience health statistics including suggestions and alerts

audienceImport

audienceImports

audienceSavedSearch

audienceSavedSearches

audienceStatsByDay

audiences

campaign

campaignContentVariation

campaignContentVariationVersions

campaignDataFields

campaignHistoryStats

campaignImpact

Get engagement impact metrics for a specific campaign, showing how the campaign affected subscriber engagement levels

campaignLinks

campaignRecipients

campaignStats

campaigns

Return a paginated list of campaigns. Optionally filter by name using a partial or full match.

checkAddOnHistory

checkSyncEligibility

Non-null

Check if an integration can be synced

contact

contactConversations

contactCount

contactEvents

Non-null

contactJourneyConversions

contactJourneyGoals

contactNotes

contacts

contactsCount

Non-null

contentBlock

contentBlockContent

countries

crmActivityTypes

Retrieves activity types based on the provided filters. Can retrieve activity types from either integration partners or native Tarvent activity types (future feature).

crmCalendar

Retrieves a single calendar by ID. Can retrieve calendars from either integration partners or native Tarvent calendars (future feature).

crmCalendars

Retrieves multiple calendars based on the provided filters. Can retrieve calendars from either integration partners or native Tarvent calendars (future feature).

crmContactTypes

Retrieves contact types. Can retrieve contact types from either integration partners or native Tarvent contact types (future feature).

crmGroup

Retrieves a single group by ID.

crmGroups

Retrieves multiple groups based on the provided filters.

crmLeadStatuses

Retrieves lead statuses. Can retrieve lead statuses from either integration partners or native Tarvent lead statuses (future feature).

crmPipeline

Retrieves a single pipeline by ID. Can retrieve pipelines from either integration partners or native Tarvent pipelines (future feature).

crmPipelines

Retrieves multiple pipelines based on the provided filters. Can retrieve pipelines from either integration partners or native Tarvent pipelines (future feature).

crmTags

Retrieves tags based on the provided filters. Can retrieve tags from either integration partners or native Tarvent tags (future feature).

crmUsers

Retrieves user from the integration partner

customApiEvent

customApiEvents

customReport

Non-null

customReportJob

Non-null

domain

domains

engagementAnalysis

Get engagement analysis with trends, distributions, AI insights, and segment recommendations

engagementBreakdown

Get engagement breakdown for an audience

executiveSummary

Get executive summary for an audience with insights and campaign performance

export

fieldMappings

Non-null

Get current field mappings for an integration

file

fileStorageStatsByDay

files

folders

form

formActionStats

formQuestion

formQuestions

formResponses

formStats

forms

growthHealth

Get growth and health statistics for an audience including trends and churn analysis

integrationCustomFields

Non-null

Get available custom fields for an integration

integrationPartner

Return a specific integration

integrationSyncHistory

Non-null

Get sync history for an integration

integrationSyncJob

Get a specific sync job by ID for an integration

journey

journeyCampaignStats

journeyCompletesByDay

journeyContactStats

journeyContactStatsByDay

journeyContacts

journeyConversion

journeyConversionContacts

journeyConversionStatsByDay

journeyConversions

journeyDurations

journeyEntriesByDay

journeyExitsByDay

journeyGoal

journeyGoalContacts

journeyGoalStatsByDay

journeyGoals

journeyNode

Retrieves a specific journey node by its identifier.

journeyNodes

Retrieves a paginated, sortable, and filterable list of all nodes within a specified journey.

journeySiteNotification

Retrieves site notification information for a specific journey node, including group and segment filtering details.

journeySiteNotificationStats

journeySiteNotifications

journeyTags

journeys

landingPage

landingPageActionStats

landingPageStats

landingPages

languages

lastIntegrationSync

Get the last sync job for an integration

mediaAlbums

Non-null

Get albums from a media integration

permissions

queryMediaImages

Non-null

Query images from a media integration with flexible search options

realtimeSyncErrors

Get real-time sync errors not associated with a sync job

rssFeed

Non-null

sMSCampaign

sMSCampaigns

securityRole

securityRoles

servicePlan

servicePlans

states

[State !]

survey

surveyActionStats

surveyQuestion

surveyQuestions

surveyResponses

surveyStats

surveys

syncErrors

Get sync errors for a specific sync job

syncJob

Get a specific sync job

systemJourneys

systemLandingPage

systemLandingPages

systemSurvey

systemSurveys

systemTemplate

systemTemplates

tags

template

templateContent

templateTxVariables

templateVersions

templates

totalContactsByDay

totalEmailsByDay

transaction

Non-null

transactionActivity

transactionDeviceStats

transactionEvents

transactionFromDomains

transactionGroupNames

transactionPerformance

transactionPerformanceBounceStats

transactionPerformanceDeviceStats

transactionPerformanceLinkStats

transactionPerformanceSoftwareStats

transactionRecipientBounceDomains

transactionRecipientDomains

transactionSoftwareStats

transactionTopRecipientBounceDomains

transactionTrends

transactionTrendsLinks

user

userInvites

userNotification

users

videoThumbnail

view

views

webhook