Types

The schema has 15 types. Each query page links to the types that the query uses.

Objects

An object is a set of fields that a query returns.

Model

• nameString!not null

  The name of the model

• unitMetricUnit!not null

  The unit in which this model's metrics are measured in

Used by: models.

ModeledMetricQuery

• data[ModeledMetricRow!]!not null

  The array containing the modeled metric rows

• pageInfoPageInfo!not null

  Pagination info for the query

Used by: modeledMetrics.

ModeledMetricRow

• metricNameMetricName!not null

  The type of the metric

• metricValueFloat!not null

  The value of the metric

• processDateISO8601DateTime!not null

  The date the metric was created or last updated

• reportedDateString!not null

  The date the metric corresponds to. This is a date string in the format of YYYY-MM-DD

• sourceCampaignIdString!not null

  The ID for the campaign

• sourceCampaignNameStringnullable

  The name of the campaign

• sourceCampaignTacticStringnullable

  The tactic the campaign is labeled with in the Data Center, if any

• sourceChannelNameString!not null

  The data source channel of the campaign

• targetString!not null

  The name of the model that produced this metric

• targetChannelNameStringnullable

  The channel that the modeling attributes credit for this metric. Only applies to second order metrics.

Used by: ModeledMetricQuery.

PageInfo

• endCursorStringnullable

  The cursor for the next page, if there is one

• hasNextPageBooleannullable

  Whether a next page exists or not

Used by: ModeledMetricQuery, ReportedMetricQuery.

ReportedMetricQuery

• data[ReportedMetricRow!]!not null

  The array containing the reported metric rows

• pageInfoPageInfo!not null

  Pagination info for the query

Used by: reportedMetrics.

ReportedMetricRow

• campaignIdString!not null

  The ID for the campaign

• campaignNameStringnullable

  The name of the campaign

• channelNameString!not null

  The data source channel of the campaign

• processDateISO8601Date!not null

  The date the metric was created or last updated

• reportedDateISO8601Date!not null

  The date the metric corresponds to

• spendFloat!not null

  The spend amount for the campaign on this date

Used by: ReportedMetricQuery.

Enums

An enum is a fixed list of values. Write a value without quotation marks in a query, and as a string in the variables.

MetricName

• FIRST_ORDER_CONVERSIONS

  New Customers attributed to direct conversions from the campaign, such as last click attribution

• FIRST_ORDER_LEADS

  Leads attributed to direct conversions from the campaign, such as last click attribution

• FIRST_ORDER_REVENUE

  Revenue attributed to direct conversions from the campaign, such as last click attribution

• FIRST_ORDER_SUBSCRIPTIONS

  Subscriptions attributed to direct conversions from the campaign, such as last click attribution

• SECOND_ORDER_CONVERSIONS

  New Customers attributed to halo effects from the campaign

• SECOND_ORDER_LEADS

  Leads attributed to halo effects from the campaign

• SECOND_ORDER_REVENUE

  Revenue attributed to halo effects from the campaign

• SECOND_ORDER_SUBSCRIPTIONS

  Subscriptions attributed to halo effects from the campaign

Used by: ModeledMetricRow.

MetricUnit

• CUSTOMERS

  The metrics are measured in new customers

• REVENUE

  The metrics are measured by revenue in USD

• SUBSCRIPTIONS

  The metrics are measured in subscriptions

Used by: Model.

SalesChannelEnum

Sales channel for filtering modeled metrics output

• ECOMMERCE
• RETAIL

Used by: modeledMetrics.

Scalars

A scalar is one value, for example a date or a number.

BigInt

Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it’s encoded as a string.

Used by: modeledMetrics, reportedMetrics.

Boolean

The Boolean scalar type represents true or false.

Used by: PageInfo.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Used by: ModeledMetricRow, ReportedMetricRow.

ISO8601Date

An ISO 8601-encoded date

Used by: modeledMetrics, reportedMetrics, ReportedMetricRow.

ISO8601DateTime

An ISO 8601-encoded datetime

Used by: ModeledMetricRow.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Used by: channelNames, modeledMetrics, reportedMetrics, Model, ModeledMetricRow, PageInfo, ReportedMetricRow.