Access to this API requires an OAuth token provided by an authentication API.

SFDC_GET_AD_METRICS_HTTP

Get

/sfdc/advertising/{date}

Usage

curl -X GET\ -H "Authorization: [[apiKey]]"\ -H "Accept: application/json"\ "https://exportapi.jabmo.app/export/v1/sfdc/advertising/{date}"

Parameters

Path parameters

Name

Description

date

The YYYY-MM-DD formatted date

Required

Responses

Status: 200 - Advertising metrics for a given day

Schema

[
{
recordId: string
// A record identifier for this object, unique within the return set

sfdcAccountId: string
// The identifier of the Salesforce account if mapped to a Jabmo Target account, null otherwise

targetAccountId: string
// The identifier of the target account

targetAccountName: string
// The name of the target account

date: string (date)
// The ISO 8601 formatted date

campaign: string
// The name of the AD campaign

adName: string
// The name of the ad

country: string
// The country of the ad activity

region: string
// The region of the ad activity

city: string
// The city of the ad activity

impressions: integer
// Number of impressions for this aggregation

clicks: integer
// Number of clicks for this aggregation

ctr: number
// CTR (ie impressions/clicks*100)
}
]

SFDC_GET_VISITS_METRICS_HTTP

Get

/sfdc/visits/{date}

Usage

curl -X GET\ -H "Authorization: [[apiKey]]"\ -H "Accept: application/json"\ "https://exportapi.jabmo.app/export/v1/sfdc/visits/{date}"

Parameters

Path parameters

Name

Description

date

The YYYY-MM-DD formatted date

Required

Responses

Status: 200 - Website visit metrics for a given day

Schema

[
{
recordId: string
// A record identifier for this object, unique within the return set

sfdcAccountId: string
// The identifier of the Salesforce account if mapped to a Jabmo Target account, null otherwise

targetAccountId: string
// The identifier of the target account

targetAccountName: string
// The name of the target account

date: string (date)
// The ISO 8601 formatted date

landingPage: string
// URL Path of the first page of the visit

urlGroup: string
// The group that matches the URL (if defined at Jabmo level).

channel: string
// The channel of the visit. If the visit is coming from an Jabmo originating ad, then the value will be "Jabmo Ad"

source: string
// The value of the utm_source parameter

medium: string
// The value of the utm_medium parameter

campaign: string
// The value of the utm_medium parameter

country: string
// The country of the ad activity

region: string
// The region of the ad activity

city: string
// The city of the ad activity

total_time_engaged: number
// The total time engaged in seconds for this aggregation of visits

total_pageview_number: number
// The total number of page views for this aggregation of visits

count: integer
// The number of visits for this aggregation.
}
]
Did this answer your question?