Marketing Metrics
Reference document for the ratios and metrics produced by the marketing metrics endpoint
The Marketing Metrics endpoint retrieves the marketing to revenue and marketing to expense metrics over one or more periods of time. These marketing metrics are calculated from accounting data. It is generated from data available on the customer's profit and loss statement.
Refer to the Assess reporting structure page for more detail on reports in Assess.
For Marketing Metrics, these are the dimensions and measures:
Dimensions
- Period
- Marketing metrics
- Metric inputs: displays only when
showInputValuesis set to true.
Measures
- Percentage
- Percentage change
- Value
Report Data
- Is structured based on dimension (index =“0”), i.e. Period.
- The endpoint will return marketing to expense and marketing to revenue metrics for each period.
View the Marketing Metrics formulas.
The endpoint is available in Swagger under Assess.
GET /data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing
Parameters
Parameter | Type | Description | Required |
|---|---|---|---|
reportDate | string | YYYY-MM-DD Datetime or Date (inclusive of the whole day). | Required |
periodLength | integer | Based on the period unit provided. It must be positive, not zero and an integer. | Required |
numberOfPeriods | integer | The number of periods to return. It must be positive, not zero and an integer. | Required |
includeDisplayNames | boolean | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. Default is 'false'. | Optional |
showInputValues | boolean | If set to true, then the system includes the input values within the response. Default to 'false'. | Optional |
Data model
The response structure is split into four areas: Report info, Dimensions, Measures and Report data.
Report info
Field | Type | Description |
|---|---|---|
name | string | "marketing_metrics" |
displayName | string | "Marketing metrics" |
Dimensions
Marketing metrics consists of these dimensions: Period, Marketing metrics and Metric inputs.
Dimension (index = “0”): Period
Field | Type | Description |
|---|---|---|
displayName | string | "Period" |
type | string | "datespan" |
items | array | Returns an array of “Period”. This is driven by the query parameter values. Ordered by latest to earliest periods. |
Dimension (index = “0”) items
Dimension (index = “1”): Marketing metrics
Field | Type | Description |
|---|---|---|
displayName | string | "Marketing metrics" |
type | string | "string" |
items | array | Returns an array of marketing metrics. |
Dimension (index = “1”) items
Field | Type | Description |
|---|---|---|
value | string |
This will always show for any response in this report. The dimension values are not dependent on the user’s query parameters. |
Dimension (index = "2"): Metric inputs
This displays when the showInputValues is set to 'true'.
Field | Type | Description |
|---|---|---|
displayName | string | "Metric inputs" |
*type | string | "string" |
items | array |
Dimension (index = "2") items
Field | Type | Description |
|---|---|---|
value | string |
This shows when |
Measures
Measures provide information about the measures contained in the report data.
The measure for this report is as follows:
Index “0” - Percentage
Field | Type | Description |
|---|---|---|
displayName | string | “Percentage” |
units | string | "%" |
type | string | “percentage” |
Index “1” - Percentage change
Field | Type | Description |
|---|---|---|
displayName | string | “Percentage change vs previous period” |
units | string | "%" |
type | string | “percentage” |
Index “2” - Value
Field | Type | Description |
|---|---|---|
displayName | string | “Value” |
units | string | The currency of the P&L. |
type | string | “currency” |
Report data
The report data combines multiple reporting dimensions and outputs the value of each combination. Each dimension reference is specified.
Since the report data is reflective of two dimensions and their measures, the tables below represent each component grouping.
Each object is grouped by dimension (index=“0”) which is the number of periods specified by the user in the query parameters.
Each period will be broken down into Marketing metrics, Metric inputs.
Components are nested within each other as below (grouped by dimension (index =“0”), i.e. Period).
components - “Marketing metrics", e.g. Marketing to expense
components - “Metric inputs”, e.g. Operating expense
Components structure
Field | Type | Description |
|---|---|---|
dimension | number | Index 1 and 2, see dimensions. |
dimensionDisplayName | string | Shows when includeDisplayNames is set to true. |
item | number | |
itemDisplayName | string | Shows when includeDisplayNames is set to true. |
measures |
All components have the structure described in the Measures in components data model below.
Measures in components
Index “0” (percentage)
Field | Type | Description |
|---|---|---|
measureDisplayName | string | “Percentage" |
value | string | "%" |
Index “1” (percentage change)
Field | Type | Description |
|---|---|---|
measureDisplayName | string | “Percentage change" If the system can't calculate the percentage change, this object will not display. |
value | string | "%" |
Index "2" (value)
Field | Type | Description |
|---|---|---|
measureDisplayName | string | "Value" |
value | number |
Example data
{
"reportInfo": {
"name": "marketing_metrics",
"displayName": "Marketing metrics"
},
"dimensions": [
{
"index": 0,
"displayName": "Period",
"type": "datespan",
"items": [
{
"index": 0,
"displayName": "Period 0",
"start": "2021-03-01",
"end": "2021-03-31"
},
{
"index": 1,
"displayName": "Period 1",
"start": "2021-04-01",
"end": "2021-04-30"
}
]
},
{
"index": 1,
"displayName": "Marketing metrics",
"type": "string",
"items": [
{
"index": 0,
"value": "Marketing to revenue"
},
{
"index": 1,
"value": "Marketing to expense"
}
]
},
{
"index": 2,
"displayName": "Metric inputs",
"type": "string",
"items": [
{
"index": 0,
"value": "Operating income"
},
{
"index": 1,
"value": "Operating expense"
},
{
"index": 2,
"value": "Marketing expense"
}
]
}
],
"measures": [
{
"displayName": "Percentage",
"units": "%",
"index": 0,
"type": "percentage"
},
{
"displayName": "Percentage change vs previous period",
"units": "%",
"index": 1,
"type": "percentage"
},
{
"displayName": "Value",
"units": "GBP",
"index": 2,
"type": "currency"
}
],
"reportData": [
{
"dimension": 0,
"dimensionDisplayName": "Period",
"item": 0,
"itemDisplayName": "Period 0",
"components": [
{
"dimension": 1,
"dimensionDisplayName": "Marketing metrics",
"item": 0,
"itemDisplayName": "Marketing to revenue",
"measures": [
{
"index": 0,
"measureDisplayName": "Percentage",
"value": 1.41
},
{
"index": 1,
"measureDisplayName": "Percentage change vs previous period",
"value": -32.32
}
],
"components": [
{
"dimension": 2,
"dimensionDisplayName": "Metric inputs",
"item": 0,
"itemDisplayName": "Operating income",
"measures": [
{
"index": 2,
"measureDisplayName": "Value",
"value": 15964.55
}
]
},
{
"dimension": 2,
"dimensionDisplayName": "Metric inputs",
"item": 2,
"itemDisplayName": "Marketing expense",
"measures": [
{
"index": 2,
"measureDisplayName": "Value",
"value": 225.19
}
]
}
]
},
{
"dimension": 1,
"dimensionDisplayName": "Marketing metrics",
"item": 1,
"itemDisplayName": "Marketing to expense",
"measures": [
{
"index": 0,
"measureDisplayName": "Percentage",
"value": 2.61
},
{
"index": 1,
"measureDisplayName": "Percentage change vs previous period",
"value": -20.61
}
],
"components": [
{
"dimension": 2,
"dimensionDisplayName": "Metric inputs",
"item": 1,
"itemDisplayName": "Operating expense",
"measures": [
{
"index": 2,
"measureDisplayName": "Value",
"value": 8616.69
}
]
},
{
"dimension": 2,
"dimensionDisplayName": "Metric inputs",
"item": 2,
"itemDisplayName": "Marketing expense",
"measures": [
{
"index": 2,
"measureDisplayName": "Value",
"value": 225.19
}
]
}
]
}
]
},
{
"dimension": 0,
"dimensionDisplayName": "Period",
"item": 1,
"itemDisplayName": "Period 1",
"components": [
{
"dimension": 1,
"dimensionDisplayName": "Marketing metrics",
"item": 0,
"itemDisplayName": "Marketing to revenue",
"measures": [
{
"index": 0,
"measureDisplayName": "Percentage",
"value": 13.8
},
{
"index": 1,
"measureDisplayName": "Percentage change vs previous period",
"value": 878.47
}
],
"components": [
{
"dimension": 2,
"dimensionDisplayName": "Metric inputs",
"item": 0,
"itemDisplayName": "Operating income",
"measures": [
{
"index": 2,
"measureDisplayName": "Value",
"value": 5362.39
}
]
},
{
"dimension": 2,
"dimensionDisplayName": "Metric inputs",
"item": 2,
"itemDisplayName": "Marketing expense",
"measures": [
{
"index": 2,
"measureDisplayName": "Value",
"value": 740.11
}
]
}
]
},
{
"dimension": 1,
"dimensionDisplayName": "Marketing metrics",
"item": 1,
"itemDisplayName": "Marketing to expense",
"measures": [
{
"index": 0,
"measureDisplayName": "Percentage",
"value": 8.29
},
{
"index": 1,
"measureDisplayName": "Percentage change vs previous period",
"value": 217.17
}
],
"components": [
{
"dimension": 2,
"dimensionDisplayName": "Metric inputs",
"item": 1,
"itemDisplayName": "Operating expense",
"measures": [
{
"index": 2,
"measureDisplayName": "Value",
"value": 8928.91
}
]
},
{
"dimension": 2,
"dimensionDisplayName": "Metric inputs",
"item": 2,
"itemDisplayName": "Marketing expense",
"measures": [
{
"index": 2,
"measureDisplayName": "Value",
"value": 740.11
}
]
}
]
}
]
}
]
}
Updated 3 months ago