Close



Data Sources



General

Data Sources | General

Connections

Data Sources | Connections

Fields & Formulas

Data Sources | Fields & Formulas

Reports



Creating & Sharing

Reports | Creating & Sharing

Report Editing

Reports | Editing

Report Config

Reports | Report Config

Chart Cards

Reports | Chart Cards

Content Cards

Reports | Content Cards

Data Chat



General

Data Chat | General



General

AI | General

Clients



General

Clients | General

Integrations



General

Integrations | General

Webhook — Local & Reviews

Integrations | Webhook — Local & Reviews

Webhook — Automation Payloads

Integrations | Webhook — Automation Payloads

MCP

Integrations | MCP

Webhook — Other

Integrations | Webhook — Other

Settings



Account & Billing

Settings | Account & Billing

Users

Settings | Users

Comments & Notes

Settings | Comments & Notes

Notifications

Settings | Notifications

FAQ

Settings | FAQ

Other

Settings | Other

KPI Forecasting



General

KPI Forecasting | General

Settings & Status

KPI Forecasting | Settings & Status

Seasonality

KPI Forecasting | Seasonality

Metrics by Source

KPI Forecasting | Metrics by Source

Budget Tracking



General

Budget Tracking | General

Anomaly Detection



General

Anomaly Detection | General

Automation Jobs



General

Automation Jobs | General

Change History

Automation Jobs | Change History

URL & Page Checkers

Automation Jobs | URL & Page Checkers

Local & Reviews

Automation Jobs | Local & Reviews

Search Console

Automation Jobs | Search Console

Insights



Managing Insights

Insights | Managing Insights

Change History

Insights | Change History

URL & Page

Insights | URL & Page

Local & Reviews

Insights | Local & Reviews

Other Insight Types

Insights | Other Insight Types

Local Listings



General

Local Listings | General

Profiles & Content

Local Listings | Profiles & Content

Performance & Activity

Local Listings | Performance & Activity

Media

Local Listings | Media

Categories & Services

Local Listings | Categories & Services

Reviews



General

Reviews | General

General

Social Posts | General

Creating Posts

Social Posts | Creating Posts

Managing Posts

Social Posts | Managing Posts

Data Warehouse



Pipelines

Data Warehouse | Pipelines

Access & Credits

Data Warehouse | Access & Credits

Source Fields

Data Warehouse | Source Fields

Data Studio

Data Warehouse | Data Studio

BigQuery

Data Warehouse | BigQuery

General

Clients | General

General

Integrations | General

MCP

Integrations | MCP

Webhook — Automation Payloads

Integrations | Webhook — Automation Payloads

Webhook — Local & Reviews

Integrations | Webhook — Local & Reviews

Webhook — Other

Integrations | Webhook — Other

Account & Billing

Settings | Account & Billing

Users

Settings | Users

Comments & Notes

Settings | Comments & Notes

Notifications

Settings | Notifications

FAQ

Settings | FAQ

Other

Settings | Other

Recent Updates



Account Settings

Settings | Account & Billing

Acknowledging and Resolving Insights

Insights | Managing Insights

Add comment from Slack

Integrations | General

Add comment from Zapier

Settings | Comments & Notes

Adding a User

Settings | Users

AI Analysis Generation

Reports | Creating & Sharing

AI Credits

AI | General

AI Models

AI | General

Analysis Card

Reports | Content Cards

Anomalies Bulk Action

Anomaly Detection | General

Anomaly Algorithm

Anomaly Detection | General

Anomaly Detection

Anomaly Detection | General

Anomaly Detection Insight

Insights | Other Insight Types

Anomaly Detection Settings

Anomaly Detection | General

Anomaly Detection Webhook Payload

Integrations | Webhook — Other

Anomaly Job Common Errors

Anomaly Detection | General

An overview of Local Listings

Local Listings | General

An overview of Reviews

Reviews | General

Area Chart Card

Reports | Chart Cards

Attributes

Local Listings | Profiles & Content

Automatic Schema Updates

Data Warehouse | Pipelines

Automation: Facebook Ads Destination URL Checker

Integrations | Webhook — Automation Payloads

Automation: Google Ads Change History

Integrations | Webhook — Automation Payloads

Automation: Google Ads Destination URL Checker

Integrations | Webhook — Automation Payloads

Automation: Google Analytics Change History

Integrations | Webhook — Automation Payloads

Automation: Google Business Profile Answer

Integrations | Webhook — Local & Reviews

Automation: Google Business Profile Change History

Integrations | Webhook — Automation Payloads

Automation: Google Business Profile Pending Updates

Integrations | Webhook — Local & Reviews

Automation: Google Business Profile Question

Integrations | Webhook — Local & Reviews

Automation: Google Review

Integrations | Webhook — Local & Reviews

Automation: Google Review Change History

Integrations | Webhook — Automation Payloads

Automation Job Common Errors

Automation Jobs | General

Automation Jobs

Automation Jobs | General

Automation: Microsoft Ads Destination URL Checker

Integrations | Webhook — Automation Payloads

Automation: Page Status Checker

Integrations | Webhook — Automation Payloads

Automation: Robots.txt Change Detection

Integrations | Webhook — Automation Payloads

Automations Bulk Action

Automation Jobs | General

Automation: Search Console Activity

Integrations | Webhook — Automation Payloads

Automation: Search Console Keyword Movement

Integrations | Webhook — Automation Payloads

Auto Resolving

Insights | Managing Insights

Bar Chart Card

Reports | Chart Cards

Branding

Reports | Creating & Sharing

Budget Campaign Dynamic Filter

Budget Tracking | General

Budget Common Errors

Budget Tracking | General

Budget history

Budget Tracking | General

Budgets Bulk Actions

Budget Tracking | General

Budget Settings

Budget Tracking | General

Budget Status

Budget Tracking | General

Budget Tracker Webhook Payload

Integrations | Webhook — Other

Budget Tracking

Budget Tracking | General

Budget Webhook URL

Budget Tracking | General

Bulk Action

Local Listings | General

Bulk Upload Images

Local Listings | Media

Calendar

Social Posts | General

Cancel Subscription

Settings | Account & Billing

Card Chat

Reports | Editing

Card Data Filters

Reports | Creating & Sharing

KPI Forecasting Webhook Payload

‍
‍

KPI webhook payload overview

This reference describes the data Jepto sends to a configured KPI webhook.

KPI webhook payload fields

Use the field reference and sample payload below to understand the available values.

Payload details for KPI:

<fieldName>kpiId<fieldName> <fieldType>string<fieldType>
A 16 character alphanumeric System defined ID

<fieldName>kpiName<fieldName> <fieldType>string<fieldType>
Auto generated name or custom name given to the KPI

<fieldName>accountId<fieldName> <fieldType>string<fieldType>
A 16 character alphanumeric System defined ID

<fieldName>clientId<fieldName> <fieldType>string<fieldType>
A 16 character alphanumeric System defined ID

<fieldName>clientName<fieldName> <fieldType>string<fieldType>
Client Name

<fieldName>previousDateStart<fieldName> <fieldType>string<fieldType>
The start date of the previous comparison period

<fieldName>previousDateEnd<fieldName> <fieldType>string<fieldType>
The end date of the previous comparison period

<fieldName>previousValue<fieldName> <fieldType>string<fieldType>
The previous period results

<fieldName>status<fieldName> <fieldType>enum<fieldType> <fieldDescription>(Possible enum values: ON_TRACK, WARNING, CRITICAL)<fieldDescription>
Value of the KPI Status (On Track, Warning, Critical)

<fieldName>currentDateEnd<fieldName> <fieldType>string<fieldType>
Date of the end of the reporting period

<fieldName>currentDateStart<fieldName> <fieldType>string<fieldType>
Date of the start of the reporting period

<fieldName>currentDaysElapsed<fieldName> <fieldType>string<fieldType>
Amount of days into the current reporting period

<fieldName>currentDaysRemaining<fieldName> <fieldType>string<fieldType>
Amount of days remaining in the current reporting period

<fieldName>currentDaysRemainingPercentage<fieldName> <fieldType>string<fieldType>
Percentage value of the days remaining in the current reporting period

<fieldName>currentPercentage<fieldName> <fieldType>string<fieldType>
The current progress or achievement

<fieldName>currentValue<fieldName> <fieldType>string<fieldType>
The current value

<fieldName>currentValueAverage<fieldName> <fieldType>string<fieldType>
The average value

<fieldName>currentPacing<fieldName> <fieldType>string<fieldType>
The current rate or progress

<fieldName>predictionDateEnd<fieldName> <fieldType>string<fieldType>
The projected or estimated date of reaching goals

<fieldName>predictionDateStart<fieldName> <fieldType>string<fieldType>
The projected or estimated start date for tracking progress based on predictions

<fieldName>predictionPercentage<fieldName> <fieldType>string<fieldType>
Predicted value at the end of the reporting period

<fieldName>predictionValueAverage<fieldName> <fieldType>string<fieldType>
The average predicted value

<fieldName>targetDate<fieldName> <fieldType>string<fieldType>
The specified or desired date

<fieldName>targetValue<fieldName> <fieldType>string<fieldType>
The specified or desired value

<fieldName>history<fieldName> <fieldType>enum<fieldType>‍

<fieldName>name<fieldName> <fieldType>string<fieldType>The name or label associated with a specific KPI in its historical records
<fieldName>range<fieldName> <fieldType>string<fieldType>The range or duration of time covered by the historical KPI data
<fieldName>target<fieldName> <fieldType>string<fieldType>The desired or intended value or level for a specific KPI in its historical records
<fieldName>actual<fieldName> <fieldType>string<fieldType>The actual achieved value or level for a specific KPI in its historical records
<fieldName>previous<fieldName> <fieldType>string<fieldType>The value or level of a specific KPI in the previous historical record
<fieldName>status<fieldName> <fieldType>string<fieldType>The status or condition associated with a specific KPI in its historical records

<fieldName>graphDataCumulative<fieldName> <fieldType>string<fieldType>
Graph data in cumulative format

<fieldName>current<fieldName> <fieldType>string<fieldType>The tracked KPI values
<fieldName>target<fieldName> <fieldType>string<fieldType>Daily average to meet the target by the end of the period
<fieldName>prediction<fieldName> <fieldType>string<fieldType>Predicted daily value

<fieldName>graphDataSeries<fieldName> <fieldType>string<fieldType>
Graph data in series format

<fieldName>current<fieldName> <fieldType>string<fieldType>The tracked KPI values
<fieldName>target<fieldName> <fieldType>string<fieldType>Daily average to meet the target by the end of the period
<fieldName>prediction<fieldName> <fieldType>string<fieldType>Predicted daily value

<fieldName>period<fieldName> <fieldType>string<fieldType>
Period of time the KPI is calculated over

<fieldName>currency<fieldName> <fieldType>string<fieldType>
Symbol of the currency used in the data source of the KPI

<fieldName>unit<fieldName> <fieldType>string<fieldType>
Text description of the metric being tracked

<fieldName>startDate<fieldName> <fieldType>string<fieldType>
Date of the start of the reporting period

<fieldName>endDate<fieldName> <fieldType>string<fieldType>
Date of the end of the reporting period

<fieldName>hasSampling<fieldName> <fieldType>string<fieldType>
(Google Analytics KPI Only) The data used is a subset of all data

<fieldName>samplingPercent<fieldName> <fieldType>string<fieldType>
(Google Analytics KPI Only) The percentage of data used compared to all data

<fieldName>seasonalComponents<fieldName> <fieldType>string<fieldType>
Weekly, monthly and yearly seasonality affect on the data

<fieldName>min<fieldName> <fieldType>string<fieldType>The minimum or lowest value
<fieldName>max<fieldName> <fieldType>string<fieldType>The maximum or highest value
<fieldName>weeklySeasonality<fieldName> <fieldType>string<fieldType>Value of how much the prediction is based on the day of the week
<fieldName>yearlySeasonality<fieldName> <fieldType>string<fieldType>Value of how much the prediction is based on the day of the year‍
<fieldName>forecastPerformance<fieldName> <fieldType>string<fieldType>The statistics computed for determining accuracy of the prediction‍

<fieldName>chartImage<fieldName> <fieldType>string<fieldType>
Image of the Jepto Chart

‍

Sample KPI Webhook URL Payload:

{
  "accountId": "d83f96d935794050",
  "kpiId": "d24e859a9f3b4cb4",
  "kpiName": "Sample KPI",
  "clientName": "Cremin Inc.",
  "clientId": "fb21bb814cac49a5",
  "graphData": {
    "dailyPerformance": [
      [
        "2022-09-01",
        "1.07"
      ]
    ],
    "periodToDatePerformance": [
      [
        "2022-09-01",
        "1.07"
      ]
    ],
    "rollingAverage": [
      [
        "2022-09-01",
        "1.07"
      ],
      [
        "2022-09-02",
        "1.33"
      ],
      [
        "2022-09-03",
        "1.33"
      ],
      [
        "2022-09-04",
        "1.33"
      ],
      [
        "2022-09-05",
        "1.33"
      ],
      [
        "2022-09-06",
        "1.33"
      ],
      [
        "2022-09-07",
        "1.33"
      ],
      [
        "2022-09-08",
        "1.33"
      ],
      [
        "2022-09-09",
        "1.33"
      ],
      [
        "2022-09-10",
        "1.33"
      ],
      [
        "2022-09-11",
        "1.33"
      ],
      [
        "2022-09-12",
        "1.33"
      ],
      [
        "2022-09-13",
        "1.33"
      ],
      [
        "2022-09-14",
        "1.33"
      ],
      [
        "2022-09-15",
        "1.33"
      ],
      [
        "2022-09-16",
        "1.33"
      ],
      [
        "2022-09-17",
        "1.33"
      ],
      [
        "2022-09-18",
        "1.33"
      ],
      [
        "2022-09-19",
        "1.33"
      ],
      [
        "2022-09-20",
        "1.33"
      ],
      [
        "2022-09-21",
        "1.33"
      ],
      [
        "2022-09-22",
        "1.33"
      ],
      [
        "2022-09-23",
        "1.33"
      ],
      [
        "2022-09-24",
        "1.33"
      ],
      [
        "2022-09-25",
        "1.33"
      ],
      [
        "2022-09-26",
        "1.33"
      ],
      [
        "2022-09-27",
        "1.33"
      ],
      [
        "2022-09-28",
        "1.33"
      ],
      [
        "2022-09-29",
        "1.33"
      ],
      [
        "2022-09-30",
        "1.33"
      ]
    ],
    "prediction": [
      [
        "2022-09-01",
        "1.07"
      ],
      [
        "2022-09-02",
        "1.0"
      ],
      [
        "2022-09-03",
        "1.0"
      ],
      [
        "2022-09-04",
        "1.0"
      ],
      [
        "2022-09-05",
        "1.0"
      ],
      [
        "2022-09-06",
        "1.0"
      ],
      [
        "2022-09-07",
        "1.0"
      ],
      [
        "2022-09-08",
        "1.0"
      ],
      [
        "2022-09-09",
        "1.0"
      ],
      [
        "2022-09-10",
        "1.0"
      ],
      [
        "2022-09-11",
        "1.0"
      ],
      [
        "2022-09-12",
        "1.0"
      ],
      [
        "2022-09-13",
        "1.0"
      ],
      [
        "2022-09-14",
        "1.0"
      ],
      [
        "2022-09-15",
        "1.0"
      ],
      [
        "2022-09-16",
        "1.0"
      ],
      [
        "2022-09-17",
        "1.0"
      ],
      [
        "2022-09-18",
        "1.0"
      ],
      [
        "2022-09-19",
        "1.0"
      ],
      [
        "2022-09-20",
        "1.0"
      ],
      [
        "2022-09-21",
        "1.0"
      ],
      [
        "2022-09-22",
        "1.0"
      ],
      [
        "2022-09-23",
        "1.0"
      ],
      [
        "2022-09-24",
        "1.0"
      ],
      [
        "2022-09-25",
        "1.0"
      ],
      [
        "2022-09-26",
        "1.0"
      ],
      [
        "2022-09-27",
        "1.0"
      ],
      [
        "2022-09-28",
        "1.0"
      ],
      [
        "2022-09-29",
        "1.0"
      ],
      [
        "2022-09-30",
        "1.0"
      ]
    ],
    "target": [
      [
        "2022-09-01",
        "1.46"
      ],
      [
        "2022-09-02",
        "1.46"
      ],
      [
        "2022-09-03",
        "1.46"
      ],
      [
        "2022-09-04",
        "1.46"
      ],
      [
        "2022-09-05",
        "1.46"
      ],
      [
        "2022-09-06",
        "1.46"
      ],
      [
        "2022-09-07",
        "1.46"
      ],
      [
        "2022-09-08",
        "1.46"
      ],
      [
        "2022-09-09",
        "1.46"
      ],
      [
        "2022-09-10",
        "1.46"
      ],
      [
        "2022-09-11",
        "1.46"
      ],
      [
        "2022-09-12",
        "1.46"
      ],
      [
        "2022-09-13",
        "1.46"
      ],
      [
        "2022-09-14",
        "1.46"
      ],
      [
        "2022-09-15",
        "1.46"
      ],
      [
        "2022-09-16",
        "1.46"
      ],
      [
        "2022-09-17",
        "1.46"
      ],
      [
        "2022-09-18",
        "1.46"
      ],
      [
        "2022-09-19",
        "1.46"
      ],
      [
        "2022-09-20",
        "1.46"
      ],
      [
        "2022-09-21",
        "1.46"
      ],
      [
        "2022-09-22",
        "1.46"
      ],
      [
        "2022-09-23",
        "1.46"
      ],
      [
        "2022-09-24",
        "1.46"
      ],
      [
        "2022-09-25",
        "1.46"
      ],
      [
        "2022-09-26",
        "1.46"
      ],
      [
        "2022-09-27",
        "1.46"
      ],
      [
        "2022-09-28",
        "1.46"
      ],
      [
        "2022-09-29",
        "1.46"
      ],
      [
        "2022-09-30",
        "1.46"
      ]
    ]
  },
  "history": [
    {
      "name": "August (2022)",
      "range": "2022-08-01 - 2022-08-31",
      "target": "Target: 1.38 vs Actual: 1.33",
      "actual": 1.33,
      "previous": 1.25,
      "status": false
    },
    {
      "name": "July (2022)",
      "range": "2022-07-01 - 2022-07-31",
      "target": "Target: 1.4 vs Actual: 1.25",
      "actual": 1.25,
      "previous": 1.27,
      "status": false
    },
    {
      "name": "June (2022)",
      "range": "2022-06-01 - 2022-06-30",
      "target": "Target: 1.53 vs Actual: 1.27",
      "actual": 1.27,
      "previous": 1.39,
      "status": false
    }
  ],
  "hasSampling": false,
  "samplingPercent": 0,
  "seasonalComponents": {
    "min": null,
    "max": null,
    "weeklySeasonality": [
      [
        "2022-08-22",
        -0.04
      ],
      [
        "2022-08-23",
        -0.02
      ],
      [
        "2022-08-24",
        0
      ],
      [
        "2022-08-25",
        0.01
      ],
      [
        "2022-08-26",
        0.06
      ],
      [
        "2022-08-27",
        0.04
      ],
      [
        "2022-08-28",
        -0.04
      ]
    ],
    "yearlySeasonality": [],
    "forecastPerformance": {
      "mae": 0.15209385226719158,
      "mape": 0.11722652521017292,
      "rmse": 0.25203671181898196,
      "numberOfRows": 360
    }
  },
  "status": "CRITICAL",
  "targetMet": false,
  "rollingAverage": 1.33,
  "rollingAveragePercentage": 91.1,
  "predictionValue": 1,
  "predictionPercentage": 68.49,
  "currentValue": 1.07,
  "currentPercentage": 73.29,
  "currentPacing": 26.71,
  "currentPacingDirection": "below",
  "currency": "$",
  "currentDaysElapsed": 1,
  "currentDaysRemaining": 29,
  "currentDaysRemainingPercentage": 96.67,
  "currentDateStart": "2022-09-01",
  "currentDateEnd": "2022-09-01",
  "targetDate": "2022-09-30",
  "predictionDateEnd": "2022-09-30",
  "predictionDateStart": "2022-09-01",
  "targetValue": 1.46,
  "previousValue": 1.33,
  "previousDateStart": "2022-08-01",
  "previousDateEnd": "2022-08-31",
  "period": "MONTHLY",
  "startDate": "2022-09-01",
  "endDate": "2022-09-30",
  "unit": "CTR (All campaigns)",
  "symbol": "PERCENTAGE",
  "calculated": true,
  "chartImage": "https://app.jepto.com/account/d83f96d935794050/client/fb21bb814cac49a5/kpi/d24e859a9f3b4cb4/graph/2022-09-01T08:52:22.970649Z.png"
}

Was this article helpful?



Nice one!

Thanks a lot for your feedback! If you’d like a member of our support team to respond to you, please send a message here



Please try again

Oops! Something went wrong while submitting the form.



Nice one!

Thanks a lot for your feedback! If you’d like a member of our support team to respond to you, please send a message here



Please try again

Oops! Something went wrong while submitting the form.