Get Metric Table Data

Updated on Jan 29, 2026
Published on Nov 11, 2025

13 minute(s) read

Prev Next

Post

/api/v1/demand-gen/metric-table

Returns metric table data based on filter criteria

Header parameters

authtoken

string

Auth Token

Body parameters

Demand gen Payload

Demand gen Payload Example

{
  "oppAttribution": "primaryContact",
  "attributionType": "firstTouch",
  "staticCampaignFilter": true,
  "firstTimeCreated": true,
  "dateFilter": "previous365Day"
}

Expand All

object

filter

object

Map of selected filters

property*

object (SelectedFilter) additionalProperties

Map of selected filters

type

string

Valid values[ "INTEGER", "LONG", "DECIMAL", "FLOAT", "DOUBLE", "BOOLEAN", "STRING", "TIMESTAMP", "DATE", "AGGREGATE", "ARRAYSTRING" ]

contains

boolean

operator

string

values

Array of string

string

permissionFilter

boolean

implicit

boolean

customFilter

boolean

children

Array of object (SelectedFilter)

object Recursive

Map of selected filters

empty

boolean

dateFilter

string

Date range for analysing data

ExamplelastYear

dateGroup

string

Grouping for date data

Examplemonth

funnelView

string

View type for funnel data

Examplevolume

funnelType

string

Type of funnel analysis

Examplesnapshot

funnelSplitBy

string

Dimension to split funnel data by

funnelQuarter

string

Quarter selection for funnel analysis

Examplequarter1

funnelComparisonType

string

Type of comparison for funnel analysis

closingTime

string

Time period for closing analysis

ExampleanyTime

startDate

string

Start date for date range

endDate

string

End date for date range

compareOn

string

Dimension to compare data on

isCustom

boolean

Flag indicating if custom date range is used

Examplefalse

funnelCorrelateBy

string

Dimension to correlate funnel data by

cohortInitialStage

string

Initial stage for cohort analysis

cohortScope

string

Scope for cohort analysis

Examplestart

overlayWith

string

Dimension to overlay data with

snapshotAsOn

string

Date for snapshot analysis

conversionRatio

boolean

Flag to enable conversion ratio calculation

topCompositions

Array of string

List of top compositions to analyze

string

List of top compositions to analyze

segment

string

Segment for data analysis

attributionType

string

Type of attribution model

ExamplefirstTouch

selectedValues

Array of object (SelectedStage)

List of selected stage values

object

List of selected stage values

key

string

title

string

value

string

entity

string

entryStage

boolean

Flag indicating if this is an entry stage

insightStage

string

Stage for insight analysis

condition

string

Condition for insight analysis

column

string

Column dimension ID

orderBy

string

Field to order results by

trendOrderBySelect

string

Field to order trend results by

enableState

boolean

Flag to enable state filtering

Examplefalse

topX

string

Number of top records to return

Exampletop100

stage

string

Selected stage for analysis

state

string

Selected state for analysis

endStage

string

End stage for analysis

endState

string

End state for analysis

metrics

Array of string

List of metrics to analyze

string

List of metrics to analyze

metricGroups

Array of string

List of metric groups to analyze

string

List of metric groups to analyze

stageEntity

string

Entity type for stage analysis

sourceStageEntity

string

Source entity type for stage analysis

firstTimeCreated

boolean

Flag indicating if this is the first time the filter is created

dateFilterDimension

string

Dimension for date filtering

createdQuarter

Array of string

List of quarters for creation date filtering

string

List of quarters for creation date filtering

includeSplit

boolean

Flag to include split in results

impliedFunnel

boolean

Flag indicating if funnel is implied

Examplefalse

openAsOn

string

Date for open-as-on analysis

dateView

string

View type for date data

ExampleCREATED

cohortStartStages

Array of object (CohortStartStages)

List of start stages for cohort analysis

object

List of start stages for cohort analysis

title

string

value

string

key

string

entity

string

viewType

string

Group of metrics for view

Valid values[ "Open", "PROGRESSION_FROM_STAGE", "PROGRESSION_TO_STAGE", "PROGRESSION", "Leakage", "Generated", "DIRECT_GENERATED", "Influenced", "Regression", "Projected", "Other", "Conversion" ]

logQuery

boolean

Flag to enable query logging

Examplefalse

columns

Array of string

List of columns to include in results

string

List of columns to include in results

cohortStartStage

string

Start stage for cohort analysis

cohortStartState

string

Start state for cohort analysis

progressedStages

object

Map of stages that have progressed

property*

Array of string additionalProperties

Map of stages that have progressed

string

Map of stages that have progressed

progressedStagesBackend

object

Backend map of stages that have progressed

property*

Array of string additionalProperties

Backend map of stages that have progressed

string

Backend map of stages that have progressed

progressedPeriod

string

Time period for progression analysis

ExamplelastYear

progressedStartDate

string

Start date for progression analysis

progressedEndDate

string

End date for progression analysis

trendStartDate

string

Start date for trend analysis

trendEndDate

string

End date for trend analysis

metric

string

Metric for analysis

ExampleopenVolume

numRecord

integer (int32)

Number of records to return

order

string

Sort order for results

Examplehighest

analysisType

string

Type of analysis to perform

funnelStages

object

Map of funnel stages to states

property*

Array of string additionalProperties

Map of funnel stages to states

string

Map of funnel stages to states

parentTab

string

Parent tab for UI

Examplefunnel

stageProgressions

Array of object (StageProgression)

List of stage progressions

object

List of stage progressions

startStage

string

startState

string

endStage

string

endState

Array of string

string

query

string

key

string

chiSquareEnabled

boolean

Flag to enable chi-square analysis

smartFilter

object (Node)

Smart filter node for complex filtering

cohortStartDate

string

Start date for cohort analysis

cohortEndDate

string

End date for cohort analysis

stages

Array of string

List of stages for analysis

string

List of stages for analysis

splitValues

Array of string

List of values to split data by

string

List of values to split data by

pageCategory

string

Category of page for UI context

Valid values[ "HOME_PAGE", "PIPELINE_PROJECTION", "SNAPSHOT", "COHORT", "DEMAND_GEN", "LEAD_PRIORITIZATION", "OPP_PRIORITIZATION", "ACCOUNT_PRIORITIZATION", "MULTITOUCH", "MARKETING_EFFECTIVENESS", "ATTRIBUTION_COMPARISON", "GENERATION_ATTRIBUTION", "LEAKAGE_ATTRIBUTION", "RECOMMENDATION_ANALYTICS", "CAMPAIGN_REALLOCATION", "USERS_GROUPS", "PIPELINE_HEALTH", "PIPELINE_ANALYTICS", "JOURNEY", "UFP_INSIGHT", "PIPELINE_MOVEMENTS", "FUNNEL_HEALTH", "MARKETING_PERFORMANCE", "MARKETING_MIX", "DATA_VALIDATION", "CAMP_LIFT_ANALYSIS", "RECORD_LIST" ]

quarters

Array of string

List of quarters for analysis

string

List of quarters for analysis

debugMode

boolean

Flag to enable debug mode

summaryMetric

string

Metric for summary analysis

compareWith

string

Period to compare with

ExamplelastWeek

selectionType

string

Type of selection

ExamplestagesSelected

dgeCohortRequest

boolean

Flag for demand generation cohort request

Examplefalse

includeTrends

boolean

Flag to include trends in results

exportContext

object (ExportContext)

Context for data export

viewId

string

viewName

string

page

string

requestedAt

integer (int64)

requestedAtStr

string

pageName

string

url

string

marketingSourcedQuery

boolean

Flag for marketing sourced queries

cumulativeAttainment

boolean

Flag for cumulative attainment calculation

chartView

string

View type for charts

cohortTrendAsOn

string

Date for cohort trend analysis

configId

string

ID of the configuration

secondaryStartDate

string

Secondary start date for comparison

secondaryEndDate

string

Secondary end date for comparison

secondaryMetric

string

Secondary metric for comparison

controlValue

string

Value for control group

viewTrends

string

Type of trend view

groupBy

object

Map of dimensions to group results by

property*

Array of string additionalProperties

Map of dimensions to group results by

string

Map of dimensions to group results by

accountStage

string

Stage for account analysis

accountStageValue

string

Value of account stage

entityId

string

ID of the entity

allowFutureDate

boolean

Flag to allow future dates in date ranges

recordListRequest

boolean

Flag for record list requests

recordListId

string

ID of the record list

applyLimit

boolean

Flag to apply limit to query results

Exampletrue

pageRequest

object (PageRequestObject)

Pagination and sorting parameters

ExamplePageRequest.of(0, 10, Sort.by("CampaignName"))

sort

object (Sort)

empty

boolean

sorted

boolean

unsorted

boolean

offset

integer (int64)

pageNumber

integer (int32)

pageSize

integer (int32)

paged

boolean

unpaged

boolean

includeColumns

Array of string

Dimensions and Metrics to include in request

Example[ "CampaignType", "CampaignName", "generatedLeadVolume" ]

string

Dimensions and Metrics to include in request

Example["CampaignType","CampaignName","generatedLeadVolume"]

includeMetrics

Array of string

Metrics to include in the request

Example[ "generatedLeadVolume", "generatedLeadValue" ]

string

Metrics to include in the request

Example["generatedLeadVolume","generatedLeadValue"]

queries

object

Query parameters for filtering data

Example{ "CampaignType": "Email", "CampaignName": "Q1 Campaign" }

property*

string additionalProperties

Query parameters for filtering data

Example{"CampaignType":"Email","CampaignName":"Q1 Campaign"}

campaignDateCol

string

Column name for campaign date filtering

ExampleCampaignStartDate

top

integer (int32)

Number of top records to return

Example10

sortOrder

string

Sort order for the results

Valid values[ "HIGHEST", "LOWEST" ]

ExampleASC or DESC

orderByMetric

string

Metric name to order results by

ExamplegeneratedLeadVolume

funnelSnapshot

boolean

Flag to indicate if funnel snapshot is required

Exampletrue

sideTableTab

string

Tab name for side table

Examplesummary

campaignDateFilter

string

Predefined time period for campaign date filtering

ExamplelastYear

campaignStartDate

string

Start date for campaign date range filter

Example2023-01-01

campaignEndDate

string

End date for campaign date range filter

Example2023-12-31

campaignMetricDateFilter

string

Predefined time period for campaign metric date filtering

ExamplelastYear

campaignMetricStartDate

string

Start date for campaign metric date range filter

Example2023-01-01

campaignMetricEndDate

string

End date for campaign metric date range filter

Example2023-12-31

campMemberEngDateFilter

string

Predefined time period for campaign member engagement date filtering

ExamplelastYear

campMemberEngStartDate

string

Start date for campaign member engagement date range filter

Example2023-01-01

campMemberEngEndDate

string

End date for campaign member engagement date range filter

Example2023-12-31

leadLookBackWindow

integer (int32)

Look back window in days for lead metrics

Example30

oppLookBackWindow

integer (int32)

Look back window in days for opportunity metrics

Example90

secondCall

boolean

Flag to indicate if this is a second API call

Examplefalse

thirdCall

boolean

Flag to indicate if this is a third API call

Examplefalse

controls

object (DGControls)

Demand generation control parameters

trend

object (TrendControl)

enabled

boolean

metric

string

viewBy

string

funnel

object (FunnelControls)

enabled

boolean

metric

string

colorCode

object (ColorCodeControls)

enabled

boolean

metric

Array of string

string

waterfall

object (WaterfallControls)

enabled

boolean

stage

string

metric

string

view

string

viewBy

string

growth

object (GrowthControls)

enabled

boolean

metric

Array of string

string

viewBy

string

growthType

string

wowMetrics

Array of string

Week over week metrics to include

Example[ "generatedLeadVolume", "generatedLeadValue" ]

string

Week over week metrics to include

Example["generatedLeadVolume","generatedLeadValue"]

metricCategory

string

Category of metrics to include

Examplevolume

leakedTimePeriod

string

Predefined time period for leaked metrics

ExamplelastYear

leakedStartDate

string

Start date for leaked metrics date range

Example2023-01-01

leakedEndDate

string

End date for leaked metrics date range

Example2023-12-31

reallocationLogic

string

Logic for budget reallocation

Exampleproportional

topCampaignNum

integer (int32)

Number of top campaigns to consider for reallocation

Example5

bottomCampaignNum

integer (int32)

Number of bottom campaigns to consider for reallocation

Example5

reallocationCriteria

string

Criteria for budget reallocation

Exampleperformance

test

boolean

Flag to indicate if this is a test request

Examplefalse

keyMetricRequest

boolean

Flag to indicate if only key metrics are requested

Exampletrue

skipNullSpend

boolean

Flag to skip campaigns with null spend

Exampletrue

implicitSpendSortingEnabled

boolean

Flag to enable implicit sorting by spend

Exampletrue

staticCampaignFilter

boolean

Flag to use static campaign filters

Examplefalse

topSort

boolean

Flag to sort by top values

Exampletrue

metricTrendSplit

string

Split type for metric trends

Examplemonthly

metricTrendCampaignName

string

Campaign name for metric trend analysis

ExampleQ1 Email Campaign

metricTrendIsCumulative

boolean

Flag to indicate if metric trend is cumulative

Examplefalse

stageDGE

string

Stage for demand generation engine

Examplelead

trendCount

integer (int32)

Maximum number of trend data points to return

Example12

attrMetricStoreColumn

string

Column name for attribution metric store

ExampleattributionModel

oppAttribution

string

Opportunity attribution model

ExamplefirstTouch

contributionType

string

Type of contribution analysis

Exampledirect

engagementFilters

object (JourneyFilter)

filter

object

Map of selected filters

property*

object (SelectedFilter) additionalProperties

Map of selected filters

type

string

Valid values[ "INTEGER", "LONG", "DECIMAL", "FLOAT", "DOUBLE", "BOOLEAN", "STRING", "TIMESTAMP", "DATE", "AGGREGATE", "ARRAYSTRING" ]

contains

boolean

operator

string

values

Array of string

string

permissionFilter

boolean

implicit

boolean

customFilter

boolean

children

Array of object (SelectedFilter)

object Recursive

Map of selected filters

empty

boolean

dateFilter

string

Date range for analysing data

ExamplelastYear

dateGroup

string

Grouping for date data

Examplemonth

funnelView

string

View type for funnel data

Examplevolume

funnelType

string

Type of funnel analysis

Examplesnapshot

funnelSplitBy

string

Dimension to split funnel data by

funnelQuarter

string

Quarter selection for funnel analysis

Examplequarter1

funnelComparisonType

string

Type of comparison for funnel analysis

closingTime

string

Time period for closing analysis

ExampleanyTime

startDate

string

Start date for date range

endDate

string

End date for date range

compareOn

string

Dimension to compare data on

isCustom

boolean

Flag indicating if custom date range is used

Examplefalse

funnelCorrelateBy

string

Dimension to correlate funnel data by

cohortInitialStage

string

Initial stage for cohort analysis

cohortScope

string

Scope for cohort analysis

Examplestart

overlayWith

string

Dimension to overlay data with

snapshotAsOn

string

Date for snapshot analysis

conversionRatio

boolean

Flag to enable conversion ratio calculation

topCompositions

Array of string

List of top compositions to analyze

string

List of top compositions to analyze

segment

string

Segment for data analysis

attributionType

string

Type of attribution model

ExamplefirstTouch

selectedValues

Array of object (SelectedStage)

List of selected stage values

object

List of selected stage values

key

string

title

string

value

string

entity

string

entryStage

boolean

Flag indicating if this is an entry stage

insightStage

string

Stage for insight analysis

condition

string

Condition for insight analysis

column

string

Column dimension ID

orderBy

string

Field to order results by

trendOrderBySelect

string

Field to order trend results by

enableState

boolean

Flag to enable state filtering

Examplefalse

topX

string

Number of top records to return

Exampletop100

stage

string

Selected stage for analysis

state

string

Selected state for analysis

endStage

string

End stage for analysis

endState

string

End state for analysis

metrics

Array of string

List of metrics to analyze

string

List of metrics to analyze

metricGroups

Array of string

List of metric groups to analyze

string

List of metric groups to analyze

stageEntity

string

Entity type for stage analysis

sourceStageEntity

string

Source entity type for stage analysis

firstTimeCreated

boolean

Flag indicating if this is the first time the filter is created

dateFilterDimension

string

Dimension for date filtering

createdQuarter

Array of string

List of quarters for creation date filtering

string

List of quarters for creation date filtering

includeSplit

boolean

Flag to include split in results

impliedFunnel

boolean

Flag indicating if funnel is implied

Examplefalse

openAsOn

string

Date for open-as-on analysis

dateView

string

View type for date data

ExampleCREATED

cohortStartStages

Array of object (CohortStartStages)

List of start stages for cohort analysis

object

List of start stages for cohort analysis

title

string

value

string

key

string

entity

string

viewType

string

Group of metrics for view

Valid values[ "Open", "PROGRESSION_FROM_STAGE", "PROGRESSION_TO_STAGE", "PROGRESSION", "Leakage", "Generated", "DIRECT_GENERATED", "Influenced", "Regression", "Projected", "Other", "Conversion" ]

logQuery

boolean

Flag to enable query logging

Examplefalse

columns

Array of string

List of columns to include in results

string

List of columns to include in results

cohortStartStage

string

Start stage for cohort analysis

cohortStartState

string

Start state for cohort analysis

progressedStages

object

Map of stages that have progressed

property*

Array of string additionalProperties

Map of stages that have progressed

string

Map of stages that have progressed

progressedStagesBackend

object

Backend map of stages that have progressed

property*

Array of string additionalProperties

Backend map of stages that have progressed

string

Backend map of stages that have progressed

progressedPeriod

string

Time period for progression analysis

ExamplelastYear

progressedStartDate

string

Start date for progression analysis

progressedEndDate

string

End date for progression analysis

trendStartDate

string

Start date for trend analysis

trendEndDate

string

End date for trend analysis

metric

string

Metric for analysis

ExampleopenVolume

numRecord

integer (int32)

Number of records to return

order

string

Sort order for results

Examplehighest

analysisType

string

Type of analysis to perform

funnelStages

object

Map of funnel stages to states

property*

Array of string additionalProperties

Map of funnel stages to states

string

Map of funnel stages to states

parentTab

string

Parent tab for UI

Examplefunnel

stageProgressions

Array of object (StageProgression)

List of stage progressions

object

List of stage progressions

startStage

string

startState

string

endStage

string

endState

Array of string

string

query

string

key

string

chiSquareEnabled

boolean

Flag to enable chi-square analysis

smartFilter

object (Node)

Smart filter node for complex filtering

cohortStartDate

string

Start date for cohort analysis

cohortEndDate

string

End date for cohort analysis

stages

Array of string

List of stages for analysis

string

List of stages for analysis

splitValues

Array of string

List of values to split data by

string

List of values to split data by

pageCategory

string

Category of page for UI context

quarters

Array of string

List of quarters for analysis

string

List of quarters for analysis

debugMode

boolean

Flag to enable debug mode

summaryMetric

string

Metric for summary analysis

compareWith

string

Period to compare with

ExamplelastWeek

selectionType

string

Type of selection

ExamplestagesSelected

dgeCohortRequest

boolean

Flag for demand generation cohort request

Examplefalse

includeTrends

boolean

Flag to include trends in results

exportContext

object (ExportContext)

Context for data export

viewId

string

viewName

string

page

string

requestedAt

integer (int64)

requestedAtStr

string

pageName

string

url

string

marketingSourcedQuery

boolean

Flag for marketing sourced queries

cumulativeAttainment

boolean

Flag for cumulative attainment calculation

chartView

string

View type for charts

cohortTrendAsOn

string

Date for cohort trend analysis

configId

string

ID of the configuration

secondaryStartDate

string

Secondary start date for comparison

secondaryEndDate

string

Secondary end date for comparison

secondaryMetric

string

Secondary metric for comparison

controlValue

string

Value for control group

viewTrends

string

Type of trend view

groupBy

object

Map of dimensions to group results by

property*

Array of string additionalProperties

Map of dimensions to group results by

string

Map of dimensions to group results by

accountStage

string

Stage for account analysis

accountStageValue

string

Value of account stage

entityId

string

ID of the entity

allowFutureDate

boolean

Flag to allow future dates in date ranges

recordListRequest

boolean

Flag for record list requests

recordListId

string

ID of the record list

applyLimit

boolean

Flag to apply limit to query results

Exampletrue

journeyFor

string

journeyAnalysisType

string

createdStage

string

progressedDateFilter

string

progressedStage

string

top

integer (int32)

engagements

Array of string

string

source

Array of string

string

engagementMode

string

journey

string

startWith

Array of string

string

endWith

Array of string

string

hasAny

Array of string

string

journeysBy

string

touchPoint

string

funnelContext

object (FunnelContext)

source

string

Valid values[ "STANDARD", "CUSTOM" ]

funnelConfigType

string

forTouchPoint

boolean

sequenceFilter

object (SequenceFilter)

logicalOperator

string

Valid values[ "AND", "OR", "IF", "ELSEIF", "ELSE" ]

sequence

Array of object (Sequence)

object

immediate

boolean

sequenceList

Array of string

string

sequenceQuery

string

touchPointSequenceQuery

string

engagementPeriod

string

smartFilterPresent

boolean

engagementType

string

engagementBy

string

touchPointConsidered

string

engagementTypes

Array of string

string

engagementChannels

Array of string

string

pageType

Array of string

string

engagementDesc

Array of string

string

engagementDate

string

engagementFromDate

string

engagementEndDate

string

campaignStartDate

string

campaignFromDate

string

campaignEndDate

string

recordList

object (RecordList)

Record list configuration for data retrieval

createdBy

string

modifiedBy

string

createdAt

integer (int64)

modifiedAt

integer (int64)

deleted

boolean

string

tenantId

string

name

string

description

string

recordType

string

Valid values[ "Lead", "Opportunity", "Account" ]

creationType

string

Valid values[ "Static", "Dynamic" ]

viewId

string

viewName

string

path

string

pathDetail

string

module

string

count

integer (int32)

stage

string

config

object

property*

object additionalProperties

filePath

string

query

string

stageRange

object (StageRange)

Range of stages for analysis

startStage

string

endStage

string

overallRowNum

boolean

Flag to include overall row numbers

Examplefalse

postPipelineBooking

boolean

Flag to include post-pipeline booking metrics

Exampletrue

postOppInfMetrics

boolean

Flag to include post-opportunity influenced metrics

Exampletrue

preOppMetrics

boolean

Flag to include pre-opportunity metrics

Exampletrue

allKeyMetrics

boolean

Flag to include all key metrics

Exampletrue

recordList

object (RecordList)

Record list configuration for data retrieval

createdBy

string

modifiedBy

string

createdAt

integer (int64)

modifiedAt

integer (int64)

deleted

boolean

string

tenantId

string

name

string

description

string

recordType

string

Valid values[ "Lead", "Opportunity", "Account" ]

creationType

string

Valid values[ "Static", "Dynamic" ]

viewId

string

viewName

string

path

string

pathDetail

string

module

string

count

integer (int32)

stage

string

config

object

property*

object additionalProperties

filePath

string

query

string

stageRange

object (StageRange)

Range of stages for analysis

startStage

string

endStage

string

Responses

200

Expand All

object

result

boolean

cachedData

boolean

requestId

string

data

object

message

string

errorCode

string

errorMessage

string

metadata

object

property*

object additionalProperties

Was this article helpful?

Documentation Index

Get Metric Table Data