Reporting API Documentation

Welcome to Jampp's Reporting API documentation. This allows for automated access to reports fitted for your needs, obtaining the metrics grouped by the dimensions of you choice. Extract insights on performance by analyzing funnel metrics; impressions, clicks, installs and in-app events across different dimensions (e.g. country, site bundle, ad type and size, etc). On this documentation you will find the information needed to query the API, from authentication to detailed examples of usage.

Contact

Product Support Team

productsupport@jampp.com

API Endpoints
https://reporting-api.com/graphql

Authentication

In order to use the API, each request needs an access token. Below you will find the steps to generate this token and details on how to send it, according to the OAuth 2.0 Client Credentials specifications.

Step 1 - User Credentials (API Keys)

Generate user credentials (Client ID and Client Secret) from Ruby: https://app.jampp.com/users/credentials

You can generate as many credentials as you want. We suggest you create one API key pair for each service you want to integrate, this way you can later invalidate access to each service individually (by deleting the API key) without impacting the others.

Step 2 - Requesting an Access Token

To retrieve the access token for a given credential, you must perform a POST HTTP request to our OAuth token endpoint with the following payload:

  • grant_type: This needs to be the exact string client_credentials.
  • client_id: The client id of the credential, which can be found in the Credentials section of the dashboard.
  • client_secret: The client secret of the credential, also available in the Credentials section.

The response should consist of a JSON with the following fields:

  • access_token: This is the access token you will need to include in the successive requests.
  • token_type: The token type, which will be the string Bearer.
  • expires_in: The number of seconds this token will be valid.
$ curl \
    -XPOST https://auth.jampp.com/v1/oauth/token \
    -d 'grant_type=client_credentials' \
    -d 'client_id=$CLIENT_ID' \
    -d 'client_secret=$CLIENT_SECRET'
{"access_token":"token","token_type":"Bearer","expires_in":7200}

Step 3 - Using the Access Token

The access token needs to be sent in the Authorization header of every API request in the format Bearer {access_token}. For example: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

$ export TOKEN=$(curl -s \
    -XPOST https://auth.jampp.com/v1/oauth/token \
    -d "grant_type=client_credentials" \
    -d "client_id=$CLIENT_ID" \
    -d "client_secret=$CLIENT_SECRET" | jq -r '.access_token')
$ curl \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST \
    https://reporting-api.jampp.com/v1/graphql \
    -d '{"query": "{ invalidQuery }"}'

Usage

Now that you know how to authenticate yourself against the API, it's time to execute some reports.

NOTE: This section will assume a TOKEN environment variable exists on the environment, and that you have installs the gql-cli

One of the simplest reports one can do, is to get the spend per campaign for a particular time range.

The query for this kind of report looks like the following:

query spendPerCampaign($from: DateTime!, $to: DateTime!) {
  spendPerCampaign: pivot(from: $from, to: $to) {
    results {
      campaignId
      campaign
      spend
    }
  }
}

If you save this query on a file named query.gql, you can execute it against the API by doing the following:

$ cat query.gql | gql-cli \
                https://reporting-api.jampp.com/v1/graphql \
                --variables "from:2022-07-01" "to:2022-07-02T01:00:00" \
                --headers "Authorization:Bearer $TOKEN" | jq
            
            {
              "spendPerCampaign": {
                "results": [
                  {
                    "campaignId": 1,
                    "campaign": "Campaign 1",
                    "spend": 10492.259863167761
                  },
                  {
                    "campaignId": 2,
                    "campaign": "Campaign 2",
                    "spend": 7164.6068600564395
                  }
                ]
              }
            }

You might also want to get the results for a particular campaign, instead of all of them. For that, you would use the filter argument of the pivot query. You might also be interested in having the spend per day for a whole week, and for that you should use the date dimension in conjunction with the granularity argument. Timezones are another thing you can customize, using context with sqlTimezone and a valid joda-time.

query spendPerDay(
  $from: DateTime!,
  $to: DateTime!,
  $campaignId: Int!,
) {
  spendPerDay: pivot(
    from: $from,
    to: $to,
    filter: {
      campaignId: {
          equals: $campaignId
      }
    }
    context: {
        sqlTimeZone: "America/Buenos_Aires"
    }
  ) {
    results {
      date(granularity: DAILY)
      spend
    }
  }
}

There's plenty of features to make you access the data you want faster. You could see that the API offers:

  • cleanups statements, they are executed after the main report is processed, and filter based on the result.
    • Is a Pivot input, and can be applied to a selection of columns like cleanup: {clicks: {greaterThan: "0"}}
    • Valid operations are greaterThan, greaterOrEqualThan, lowerThan, lowerOrEqualThan
  • fragments, reusable units of logic
    • Let's say you have complicated request, one that repeats fields at least once Fragments let you construct sets of fields, and then include them in queries where you need to.
    • Forat is showed in the example below
  • totals results, aggregated metrics.
    • They syntax is the same as results, but they accept less dimensions, since not all of them can be aggregated together
fragment metrics on PivotMetrics {
              impressions
              uniqueImpressions
              clicks
            }
            
            fragment moreMetrics on PivotMetrics {
              events
              uniqueEvents
              ...metrics
            }
            
            query TestQuery {
              pivot(
                from: DateTime!, to: DateTime!,
                cleanup: {clicks: {greaterThan: "0"}},
                options: {removeZeroRows: true, love:true}
              )
              {
                results {
                  date(granularity: DAILY)
                  app
                  ... on PivotMetrics {
                    ...moreMetrics
                  }
                }
                totals {
                  ...metrics
                }
              }
            }

If you save this query on a file named query.gql, you can execute it against the API by doing the following:

$ cat query.gql | gql-cli \
                https://reporting-api.jampp.com/v1/graphql \
                --variables \
                    "from:2022-07-01" \
                    "to:2022-07-02T01:00:00" \
                    "campaignId:1" \
                --headers "Authorization:Bearer $TOKEN" | jq
            
            {
              "spendPerDay": {
                "results": [
                  {
                    "date": "2022-07-01T00:00:00+00:00",
                    "spend": 64.59747491013285
                  },
                  {
                    "date": "2022-07-02T00:00:00+00:00",
                    "spend": 64.55113205605944
                  },
                  {
                    "date": "2022-07-03T00:00:00+00:00",
                    "spend": 64.90663006136948
                  },
                  {
                    "date": "2022-07-04T00:00:00+00:00",
                    "spend": 64.5596683552398
                  },
                  {
                    "date": "2022-07-05T00:00:00+00:00",
                    "spend": 65.15007398221789
                  },
                  {
                    "date": "2022-07-06T00:00:00+00:00",
                    "spend": 64.22643498291754
                  },
                  {
                    "date": "2022-07-07T00:00:00+00:00",
                    "spend": 64.46298256605934
                  }
                ]
              }
            }

It might also be in your interest, especially for the case of larger pivots, to execute the pivot in an asynchronous fashion and later download the results. This is possible using the createAsyncPivot mutation.

As an example, we will use the spendPerCampaign query mentioned in the beginning of this section. The asynchronous analogous of this query looks like the following:

mutation asyncSpendPerCampaign($from: DateTime!, $to: DateTime!) {
  createAsyncPivot(
    Input: {
      from: $from,
      to: $to,
      dimensions: ["campaignId", "campaign"],
      metrics: ["spend"]
    }
  ) {
    asyncPivot {
      id
      status
    }
  }
}

If we save the query on a create_async_pivot.gql and execute this graphql, we get the following:

$ cat create_async_pivot.gql | gql-cli \
                https://reporting-api.jampp.com/v1/graphql \
                --variables "from:2022-07-01" "to:2022-07-02T01:00:00" \
                --headers "Authorization:Bearer $TOKEN" | jq
            
            {
              "createAsyncPivot": {
                "asyncPivot": {
                  "id": "3a818623-25f1-4b2b-ae07-67d09c173ed6",
                  "status": "PENDING"
                }
              }
            }

We can later check the status of the newly created asynchronous pivot by using the ID. We will open a new file named check_async_pivot.gql with the following query:

query checkAsyncPivot($id: String!) {
  asyncPivot(pivotId: $id) {
    status
    url
  }
}

and execute it using the following command:

$ cat check_async_pivot.gql | gql-cli \
                https://reporting-api.jampp.com/v1/graphql \
                --variables "id: YOUR-PIVOT-ID" \
                --headers "Authorization:Bearer $TOKEN" | jq
            
            {
              "checkAsyncPivot": {
                "asyncPivot": {
                  "status": "READY",
                  "url": "https://your-results-will-be-here.csv"
                }
              }
            }

Once the asynchronous pivot reaches the READY status, the URL attribute of the async pivot will contain a signed url pointing to a CSV file with the content of the pivot result. It will look like this:

$ curl URL_OF_ASYNC_PIVOT
campaignId,campaign,spend
1,Campaign 1,10492.259863167761
2,Campaign 2,7164.6068600564395

Reporting API Client

We have developed a Python client to easily connect and query this API in a programatic fashion.

Instructions on how to install and use this client can be found on the Documentation.

Queries

asyncPivot

Description

Get information about the status of your async pivot.

Response

Returns an AsyncPivot

Arguments
Name Description
pivotId - String!

Example

Query
query asyncPivot($pivotId: String!) {
  asyncPivot(pivotId: $pivotId) {
    id
    userId
    pivotParams {
      from
      to
      options
      dimensions
      metrics
      cleanup
      granularity
      filter
      cohortType
      cohortWindow
      context
    }
    status
    created
    lastUpdated
    outputType
    url
  }
}
Variables
{"pivotId": "xyz789"}
Response
{
  "data": {
    "asyncPivot": {
      "id": "abc123",
      "userId": 987,
      "pivotParams": PivotParams,
      "status": "PENDING",
      "created": "2007-12-03T10:15:30Z",
      "lastUpdated": "2007-12-03T10:15:30Z",
      "outputType": "S3",
      "url": "xyz789"
    }
  }
}
Queries

asyncPivots

Description

Get information about the status of your async pivots.

Response

Returns [AsyncPivot!]!

Arguments
Name Description
pivotIds - [String!] Default = null

Example

Query
query asyncPivots($pivotIds: [String!]) {
  asyncPivots(pivotIds: $pivotIds) {
    id
    userId
    pivotParams {
      from
      to
      options
      dimensions
      metrics
      cleanup
      granularity
      filter
      cohortType
      cohortWindow
      context
    }
    status
    created
    lastUpdated
    outputType
    url
  }
}
Variables
{"pivotIds": null}
Response
{
  "data": {
    "asyncPivots": [
      {
        "id": "xyz789",
        "userId": 123,
        "pivotParams": PivotParams,
        "status": "PENDING",
        "created": "2007-12-03T10:15:30Z",
        "lastUpdated": "2007-12-03T10:15:30Z",
        "outputType": "S3",
        "url": "xyz789"
      }
    ]
  }
}
Queries

pivot

Description

Execute a pivot against the Reporting API.

Response

Returns a Pivot!

Arguments
Name Description
from - DateTime! Date from which to execute the report. Examples: "2022-01-01", "2022-01-01T03:00:00", "2022-01-01T03:00:00+03:00".
to - DateTime! Date up to which to execute the report. Note that this date will not be included. Examples: "2022-01-01", "2022-01-01T03:00:00", "2022-01-01T03:00:00+03:00".
filter - Filter Parameter used to filter the underlying data of the report, acts the same way that a WHERE clause does on SQL. Default = null
cleanup - Cleanup Parameter used to filter rows having less (or more) events of the selected metrics. Acts the same way that a HAVING clause on SQL. Default = null
cohortType - CohortType Define the type of cohort to execute. Can be either INSTALL or TOUCH. Default = null
cohortWindow - CohortWindow When CohortType is defined, this value determines the maximum amount time after either the install, of the touch that will be allowed in order to consider the event. Default = null
context - Context Parameter used to define execution context values. Default = null
options - Options Execution flags that didnt fit anywhere else. Default = null

Example

Query
query pivot(
  $from: DateTime!,
  $to: DateTime!,
  $filter: Filter,
  $cleanup: Cleanup,
  $cohortType: CohortType,
  $cohortWindow: CohortWindow,
  $context: Context,
  $options: Options
) {
  pivot(
    from: $from,
    to: $to,
    filter: $filter,
    cleanup: $cleanup,
    cohortType: $cohortType,
    cohortWindow: $cohortWindow,
    context: $context,
    options: $options
  ) {
    results {
      ad
      adParameter
      adId
      adSet
      adSetId
      adSize
      adType
      adUrl
      advertiser
      advertiserId
      advertiserBillingEntity
      advertiserCountryId
      app
      appBundle
      appCategory
      appId
      appPlatform
      campaign
      campaignParameter
      campaignId
      campaignCountry
      campaignTrackerType
      campaignType
      campaignTypeId
      city
      countryCode
      countryName
      group
      groupParameter
      groupId
      region
      siteName
      siteCategory
      siteSubcategory
      siteBundle
      source
      sourceId
      dma
      zipCode
      campaignGoalType
      campaignContractualGoalType
      rewarded
      skadConversionWindow
      skadAnon
      deviceType
      proxyType
      skoverlay
      skippable
      date
      dateToStr
      dayOfWeek
      timeOfDay
      impressions
      clicks
      cpc
      cpm
      ctr
      spend
      wins
      bidToWinRate
      uniqueImpressions
      uniqueClicks
      skadAssistedInstalls
      uniqueEvents
      events
      assistedEvents
      assistedEventValue
      eventValue
      eventsCpa
      eventsRoas
      eventsIte
      eventsRate
      installs
      installsCpi
      installsCvr
      installsIti
      assistedInstalls
      uniqueEventsCpa
    }
    totals {
      impressions
      clicks
      cpc
      cpm
      ctr
      spend
      wins
      bidToWinRate
      uniqueImpressions
      uniqueClicks
      skadAssistedInstalls
      uniqueEvents
      events
      assistedEvents
      assistedEventValue
      eventValue
      eventsCpa
      eventsRoas
      eventsIte
      eventsRate
      installs
      installsCpi
      installsCvr
      installsIti
      assistedInstalls
      uniqueEventsCpa
    }
  }
}
Variables
{
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z",
  "filter": null,
  "cleanup": null,
  "cohortType": "null",
  "cohortWindow": null,
  "context": null,
  "options": null
}
Response
{
  "data": {
    "pivot": {
      "results": [PivotResult],
      "totals": PivotTotals
    }
  }
}

Mutations

createAsyncPivot

Response

Returns a CreateAsyncPivotResponse!

Arguments
Name Description
Input - CreateAsyncPivotInput!

Example

Query
mutation createAsyncPivot($Input: CreateAsyncPivotInput!) {
  createAsyncPivot(Input: $Input) {
    asyncPivot {
      id
      userId
      pivotParams {
        ...PivotParamsFragment
      }
      status
      created
      lastUpdated
      outputType
      url
    }
  }
}
Variables
{"Input": CreateAsyncPivotInput}
Response
{"data": {"createAsyncPivot": {"asyncPivot": AsyncPivot}}}

Types

AsyncPivot

Fields
Field Name Description
id - String! Unique ID of the pivot.
userId - Int! ID of the user that created the asynchronous pivot.
pivotParams - PivotParams! Parameters of the report.
status - AsyncPivotStatus! Status of the report.
created - DateTime! Date when the pivot was created.
lastUpdated - DateTime! Date when the pivot status was last updated.
outputType - AsyncPivotOutputType! Type of output.
url - String URL of CSV file where to find the results.
Example
{
  "id": "xyz789",
  "userId": 123,
  "pivotParams": PivotParams,
  "status": "PENDING",
  "created": "2007-12-03T10:15:30Z",
  "lastUpdated": "2007-12-03T10:15:30Z",
  "outputType": "S3",
  "url": "abc123"
}
Types

AsyncPivotOutputType

Values
Enum Value Description

S3
Example
"S3"
Types

AsyncPivotStatus

Values
Enum Value Description

PENDING

QUEUED

RUNNING

READY

UP_FOR_RETRY

FAILED
Example
"PENDING"
Types

AttrSource

Description

Source from which the attribution was made. Can be ALL, SKAD or MMP.

Values
Enum Value Description

ALL

MMP

SKAD
Example
"ALL"
Types

AttrTouch

Description

Type of touch from which the attribution was made. Can be ALL, CLICK or IMP.

Values
Enum Value Description

ALL

CLICK

IMP
Example
"ALL"
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CampaignTrackerType

Description

Type of campaign tracking (SKAD/MMP).

Values
Enum Value Description

MMP

SKAD
Example
"MMP"
Types

CampaignTrackerTypeGenericFilter

Fields
Input Field Description
equals - CampaignTrackerType
notEquals - CampaignTrackerType
isIn - [CampaignTrackerType!]
isNotIn - [CampaignTrackerType!]
Example
{"equals": "MMP", "notEquals": "MMP", "isIn": ["MMP"], "isNotIn": ["MMP"]}
Types

CampaignType

Description

Type of campaign (UA or RTGT).

Values
Enum Value Description

UA

RTGT
Example
"UA"
Types

CampaignTypeGenericFilter

Fields
Input Field Description
equals - CampaignType
notEquals - CampaignType
isIn - [CampaignType!]
isNotIn - [CampaignType!]
Example
{"equals": "UA", "notEquals": "UA", "isIn": ["UA"], "isNotIn": ["UA"]}
Types

Cleanup

Description

Defines a criteria to filter out result rows having less (or more) than a defined threshold for the corresponding metric.

Fields
Input Field Description
clicks - LongGenericCleanup
events - LongGenericCleanup
impressions - LongGenericCleanup
installs - LongGenericCleanup
spend - FloatGenericCleanup
Example
{
  "clicks": LongGenericCleanup,
  "events": LongGenericCleanup,
  "impressions": LongGenericCleanup,
  "installs": LongGenericCleanup,
  "spend": FloatGenericCleanup
}
Types

CohortType

Description

Type of cohort to execute. Can be either INSTALL or TOUCH.

Values
Enum Value Description

INSTALL

TOUCH
Example
"INSTALL"
Types

CohortWindow

Description

Window used to determine the maximum wait time for the cohort.

Fields
Input Field Description
amount - Int!
period - Period!
Example
{"amount": 987, "period": "HOURS"}
Types

Context

Description

Parameter used to define an execution context for the pivot.

Fields
Input Field Description
sqlTimeZone - String

Define a timezone that will be used for both the results and the date input parameters (if these don't have a specific timezone defined). Valid values can be found here.
Example
{"sqlTimeZone": "America/Buenos_Aires"}
Types

CreateAsyncPivotInput

Fields
Input Field Description
from - DateTime!

Date from which to execute the report. Examples: "2022-01-01", "2022-01-01T03:00:00", "2022-01-01T03:00:00+03:00".
to - DateTime!

Date to which to execute the report. Examples: "2022-01-01", "2022-01-01T03:00:00", "2022-01-01T03:00:00+03:00".
options - Options

Execution flags that didnt fit anywhere else.
dimensions - [String!]

List of PivotDimensions for the query that will be executed.
metrics - [String!]

List of PivotMetrics for the query that will be executed.
filter - Filter

Parameter used to filter the underlying data of the report, acts the same way that a WHERE clause does on SQL.
cleanup - Cleanup

Parameter used to filter rows having less (or more) events of the selected metrics. Acts the same way that a HAVING clause on SQL.
cohortType - CohortType

Define the type of cohort to execute. Can be either INSTALL or TOUCH.
cohortWindow - CohortWindow

When CohortType is defined, this value determines the maximum amount time after either the install, of the touch that will be allowed in order to consider the event.
context - Context

Parameter used to define execution context values.
Example
{
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z",
  "options": Options,
  "dimensions": ["abc123"],
  "metrics": ["xyz789"],
  "filter": Filter,
  "cleanup": Cleanup,
  "cohortType": "INSTALL",
  "cohortWindow": CohortWindow,
  "context": Context
}
Types

CreateAsyncPivotResponse

Fields
Field Name Description
asyncPivot - AsyncPivot!
Example
{"asyncPivot": AsyncPivot}
Types

DateTime

Description

Date with time (isoformat)

Example
"2007-12-03T10:15:30Z"
Types

Filter

Description

Define a criteria by which to filter the data. A filter can be applied to most PivotDimensions. Works like a WHERE clause on SQL.

Fields
Input Field Description
adId - IntGenericFilter
adSetId - IntGenericFilter
adSize - StrGenericFilter
adType - StrGenericFilter
advertiserId - IntGenericFilter
archived - Boolean
appId - IntGenericFilter
appPlatform - PlatformGenericFilter
campaignId - IntGenericFilter
campaignCountry - StrGenericFilter
campaignGoalType - StrGenericFilter
campaignContractualGoalType - StrGenericFilter
campaignTrackerType - CampaignTrackerTypeGenericFilter
campaignType - CampaignTypeGenericFilter
campaignTypeId - IntGenericFilter
city - StrGenericFilter
countryCode - StrGenericFilter
countryName - StrGenericFilter
groupExperiment - GroupExperimentFilter
groupType - GroupTypeFilter
groupId - IntGenericFilter
region - StrGenericFilter
siteName - StrGenericFilter
siteCategory - StrGenericFilter
siteSubcategory - StrGenericFilter
siteBundle - StrGenericFilter
sourceId - IntGenericFilter
status - StatusGenericFilter
Example
{
  "adId": IntGenericFilter,
  "adSetId": IntGenericFilter,
  "adSize": StrGenericFilter,
  "adType": StrGenericFilter,
  "advertiserId": IntGenericFilter,
  "archived": false,
  "appId": IntGenericFilter,
  "appPlatform": PlatformGenericFilter,
  "campaignId": IntGenericFilter,
  "campaignCountry": StrGenericFilter,
  "campaignGoalType": StrGenericFilter,
  "campaignContractualGoalType": StrGenericFilter,
  "campaignTrackerType": CampaignTrackerTypeGenericFilter,
  "campaignType": CampaignTypeGenericFilter,
  "campaignTypeId": IntGenericFilter,
  "city": StrGenericFilter,
  "countryCode": StrGenericFilter,
  "countryName": StrGenericFilter,
  "groupExperiment": GroupExperimentFilter,
  "groupType": GroupTypeFilter,
  "groupId": IntGenericFilter,
  "region": StrGenericFilter,
  "siteName": StrGenericFilter,
  "siteCategory": StrGenericFilter,
  "siteSubcategory": StrGenericFilter,
  "siteBundle": StrGenericFilter,
  "sourceId": IntGenericFilter,
  "status": StatusGenericFilter
}
Types

Float

Description

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

Example
987.65
Types

FloatGenericCleanup

Fields
Input Field Description
greaterThan - Float
greaterOrEqualThan - Float
lowerThan - Float
lowerOrEqualThan - Float
Example
{
  "greaterThan": 123.45,
  "greaterOrEqualThan": 123.45,
  "lowerThan": 987.65,
  "lowerOrEqualThan": 123.45
}
Types

Granularity

Description

Criteria by which to truncate the date of the metrics being informed.

Values
Enum Value Description

NONE

HOURLY

DAILY

WEEKLY

MONTHLY

QUARTERLY

YEARLY

MILLENNIUM
Example
"NONE"
Types

GroupExperiment

Description

Kind of experiment the group is subject to. REGULAR if it is not part of any experiment.

Values
Enum Value Description

REGULAR

AB_TEST
Example
"REGULAR"
Types

GroupExperimentFilter

Fields
Input Field Description
equals - GroupExperiment
notEquals - GroupExperiment
Example
{"equals": "REGULAR", "notEquals": "REGULAR"}
Types

GroupType

Description

Type of group, can be either DPA or REGULAR.

Values
Enum Value Description

DPA

REGULAR
Example
"DPA"
Types

GroupTypeFilter

Fields
Input Field Description
equals - GroupType
notEquals - GroupType
Example
{"equals": "DPA", "notEquals": "DPA"}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

IntGenericFilter

Fields
Input Field Description
equals - Int
notEquals - Int
isIn - [Int!]
isNotIn - [Int!]
Example
{"equals": 987, "notEquals": 123, "isIn": [987], "isNotIn": [987]}
Types

Long

Description

Same as an integer in every sense, without size boundaries.

Example
"2147483648"
Types

LongGenericCleanup

Fields
Input Field Description
greaterThan - Long
greaterOrEqualThan - Long
lowerThan - Long
lowerOrEqualThan - Long
Example
{
  "greaterThan": "2147483648",
  "greaterOrEqualThan": "2147483648",
  "lowerThan": "2147483648",
  "lowerOrEqualThan": "2147483648"
}
Types

Options

Description

Options for the report execution.

Fields
Input Field Description
removeZeroRows - Boolean!

Reduces the bloat in the results by filtering out empty rows, default False
Example
{"removeZeroRows": true}
Types

Period

Description

Time period to be used in conjuction with the amount attribute of the CohortWindow

Values
Enum Value Description

HOURS

DAYS

WEEKS
Example
"HOURS"
Types

Pivot

Fields
Field Name Description
results - [PivotResult!]!
totals - PivotTotals!
Example
{
  "results": [PivotResult],
  "totals": PivotTotals
}
Types

PivotDimensions

Fields
Field Name Description
ad - String Name of the ad.
adParameter - String Custom field defined at an ad level to describe the ad.
adId - Int ID of the ad.
adSet - String Name of the ad set.
adSetId - Int ID of the ad set.
adSize - String Ad size of each ad.
adType - String Ad type of each ad.
adUrl - String URL of the ad.
advertiser - String Name of the advertiser.
advertiserId - Int ID of the advertiser.
advertiserBillingEntity - String Billing entity used for the corresponding campaign.
advertiserCountryId - Int Country registered for the corresponding advertiser.
app - String Name of the application.
appBundle - String Bundle ID of the application that is being advertised.
appCategory - String Category of the application that is being advertised.
appId - Int ID of the application that is being advertised.
appPlatform - Platform OS name of the application that is being advertised (IOS/ANDROID).
campaign - String Name of the advertised campaign.
campaignParameter - String Optional field in Silver's campaign form that allows the input of a custom value related to the campaign.
campaignId - Int ID of the advertised campaign.
campaignCountry - String Country to which the campaign is associated.
campaignTrackerType - CampaignTrackerType Type of campaign tracking (SKAD/MMP).
campaignType - String Type of campaign (UA or RTGT).
campaignTypeId - Int ID of type of campaign (UA=1 or RTGT=2).
city - String Name of the geo-located city in which the ad is being shown.
countryCode - String Code of the country (ISO2) in which the ad is being shown.
countryName - String Name of the country in which the ad is being shown.
group - String Name of the group related to an advertised campaign.
groupParameter - String Optional field in Silver's group form that allows the input of a custom value related to the group.
groupId - Int ID of the group related to an advertised campaign.
region - String Name of the geo-located region in which the ad is being shown.
siteName - String Name of the publisher app. Cannot be queried simultaneously with region, city, dma, zipCode, ad or adId.
siteCategory - String Appstore category of the publisher app.
siteSubcategory - String Appstore subcategory of the publisher app.
siteBundle - String Bundle ID of the publisher app. Cannot be queried simultaneously with region, city, dma, zipCode, ad or adId.
source - String Name of the exchange in which ads were purchased.
sourceId - Int ID of the exchange in which ads were purchased.
dma - String DesignatedMarketArea describes where the consumers watch.
zipCode - String Identifies a particular postal delivery area.
campaignGoalType - String Identifies the goal type configured in the campaign.
campaignContractualGoalType - String Identifies the contractual goal type configured in the campaign.
rewarded - Int Ad category by rewarded.
skadConversionWindow - Int skad conversion window.
skadAnon - Int skad anonymity tier.
deviceType - String Identifies the type of the device (smartphone, tablet, unknown)
proxyType - String Identifies the type of the proxy
skoverlay - Int Identifies if the ad was shown on a skad overlay.
skippable - Int Identifies if the ad allowed to be skipped.
date - DateTime!
Arguments
granularity - Granularity
dateToStr - String! Returns a string formatted with given format based in JodaTime Java package
Arguments
formatString - String
dayOfWeek - String!
timeOfDay - Int!
Possible Types
PivotDimensions Types

PivotResult

Example
{
  "ad": "xyz789",
  "adParameter": "abc123",
  "adId": 987,
  "adSet": "abc123",
  "adSetId": 123,
  "adSize": "xyz789",
  "adType": "xyz789",
  "adUrl": "abc123",
  "advertiser": "abc123",
  "advertiserId": 987,
  "advertiserBillingEntity": "xyz789",
  "advertiserCountryId": 987,
  "app": "abc123",
  "appBundle": "abc123",
  "appCategory": "xyz789",
  "appId": 987,
  "appPlatform": "ANDROID",
  "campaign": "xyz789",
  "campaignParameter": "xyz789",
  "campaignId": 987,
  "campaignCountry": "xyz789",
  "campaignTrackerType": "MMP",
  "campaignType": "xyz789",
  "campaignTypeId": 123,
  "city": "abc123",
  "countryCode": "xyz789",
  "countryName": "abc123",
  "group": "xyz789",
  "groupParameter": "abc123",
  "groupId": 987,
  "region": "abc123",
  "siteName": "xyz789",
  "siteCategory": "abc123",
  "siteSubcategory": "xyz789",
  "siteBundle": "abc123",
  "source": "xyz789",
  "sourceId": 987,
  "dma": "abc123",
  "zipCode": "xyz789",
  "campaignGoalType": "xyz789",
  "campaignContractualGoalType": "xyz789",
  "rewarded": 123,
  "skadConversionWindow": 987,
  "skadAnon": 123,
  "deviceType": "xyz789",
  "proxyType": "abc123",
  "skoverlay": 987,
  "skippable": 123,
  "date": "2007-12-03T10:15:30Z",
  "dateToStr": "abc123",
  "dayOfWeek": "xyz789",
  "timeOfDay": 123
}
Types

PivotMetrics

Fields
Field Name Description
impressions - Long Number of ad impressions shown.
clicks - Long Number of clicks on the ads.
cpc - Float Cost per click. Cost is defined as ad spend.
cpm - Float Cost per thousand impressions. Cost is defined as ad spend.
ctr - Float Click through rate.
spend - Float Amount of budget that was spent in that time period.
wins - Long Amount of bids that are won, only available for certain sources.
bidToWinRate - Float
uniqueImpressions - Long Has an error rate of 2% on the range of 0 to 1000M impressions,for values greater than 1000M the error rate becomes large and the metric unreliable.
uniqueClicks - Long Unique devices that have clicks 2% error.
skadAssistedInstalls - Long Amount of installs that were assisted by Jampp on skad devices.
uniqueEvents - Long Unique devices that have events.
Arguments
eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
events - Long Number of events attributed.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
assistedEvents - Long Events from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
assistedEventValue - Float Sum of purchase value related to a purchase event from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventValue - Float Sum of purchase value related to a purchase event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsCpa - Float Cost per event. Cost is defined as ad spend.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsRoas - Float Return over ad spend measured through attributed value in a purchase event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsIte - Float The percentage of every a thousand impressions that converted into an event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsRate - Float The amount of events divided by installs
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
installs - Long Number of attributed installs.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

hasCv - Boolean!

Number of SKAD installs that had a non-null conversion value in it's postback.

reinstall - Boolean!

Number of SKAD installs that had a reinstall=true in it's postback.
installsCpi - Float Cost per install. Cost is defined as ad spend.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
installsCvr - Float The percentage of clicks that converted into an install.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.
installsIti - Float The percentage of every a thousand impressions that converted into an install.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
assistedInstalls - Long Installs from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
uniqueEventsCpa - Float Cost per unique event. Cost is defined as ad spend.
Arguments
eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
Possible Types
PivotMetrics Types

PivotResult

PivotTotals

Example
{
  "impressions": "2147483648",
  "clicks": "2147483648",
  "cpc": 987.65,
  "cpm": 123.45,
  "ctr": 987.65,
  "spend": 123.45,
  "wins": "2147483648",
  "bidToWinRate": 987.65,
  "uniqueImpressions": "2147483648",
  "uniqueClicks": "2147483648",
  "skadAssistedInstalls": "2147483648",
  "uniqueEvents": "2147483648",
  "events": "2147483648",
  "assistedEvents": "2147483648",
  "assistedEventValue": 123.45,
  "eventValue": 123.45,
  "eventsCpa": 123.45,
  "eventsRoas": 123.45,
  "eventsIte": 123.45,
  "eventsRate": 987.65,
  "installs": "2147483648",
  "installsCpi": 987.65,
  "installsCvr": 123.45,
  "installsIti": 987.65,
  "assistedInstalls": "2147483648",
  "uniqueEventsCpa": 987.65
}
Types

PivotParams

Description

Parameters used to execute pivot.

Fields
Field Name Description
from - DateTime! Date from which to execute the report. Examples: "2022-01-01", "2022-01-01T03:00:00", "2022-01-01T03:00:00+03:00".
to - DateTime! Date from which to execute the report. Examples: "2022-01-01", "2022-01-01T03:00:00", "2022-01-01T03:00:00+03:00".
options - String JSON representation of options used for the report.
dimensions - [String!] List of dimensions used, in their string representation
metrics - [String!] List of metrics used, in their string representation
cleanup - String JSON representation of cleanup used for the report.
granularity - Granularity Criteria used to truncate the date, defining the date intervals for which to calculate the metrics on the report.
filter - String JSON representation of filter used for the report.
cohortType - CohortType Define the type of cohort to execute. Can be either INSTALL or TOUCH.
cohortWindow - String JSON representation of CohortWindow used for the report.
context - String JSON representation of Context used for the report.
Example
{
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z",
  "options": "xyz789",
  "dimensions": ["abc123"],
  "metrics": ["xyz789"],
  "cleanup": "abc123",
  "granularity": "NONE",
  "filter": "abc123",
  "cohortType": "INSTALL",
  "cohortWindow": "abc123",
  "context": "abc123"
}
Types

PivotResult

Fields
Field Name Description
ad - String Name of the ad.
adParameter - String Custom field defined at an ad level to describe the ad.
adId - Int ID of the ad.
adSet - String Name of the ad set.
adSetId - Int ID of the ad set.
adSize - String Ad size of each ad.
adType - String Ad type of each ad.
adUrl - String URL of the ad.
advertiser - String Name of the advertiser.
advertiserId - Int ID of the advertiser.
advertiserBillingEntity - String Billing entity used for the corresponding campaign.
advertiserCountryId - Int Country registered for the corresponding advertiser.
app - String Name of the application.
appBundle - String Bundle ID of the application that is being advertised.
appCategory - String Category of the application that is being advertised.
appId - Int ID of the application that is being advertised.
appPlatform - Platform OS name of the application that is being advertised (IOS/ANDROID).
campaign - String Name of the advertised campaign.
campaignParameter - String Optional field in Silver's campaign form that allows the input of a custom value related to the campaign.
campaignId - Int ID of the advertised campaign.
campaignCountry - String Country to which the campaign is associated.
campaignTrackerType - CampaignTrackerType Type of campaign tracking (SKAD/MMP).
campaignType - String Type of campaign (UA or RTGT).
campaignTypeId - Int ID of type of campaign (UA=1 or RTGT=2).
city - String Name of the geo-located city in which the ad is being shown.
countryCode - String Code of the country (ISO2) in which the ad is being shown.
countryName - String Name of the country in which the ad is being shown.
group - String Name of the group related to an advertised campaign.
groupParameter - String Optional field in Silver's group form that allows the input of a custom value related to the group.
groupId - Int ID of the group related to an advertised campaign.
region - String Name of the geo-located region in which the ad is being shown.
siteName - String Name of the publisher app. Cannot be queried simultaneously with region, city, dma, zipCode, ad or adId.
siteCategory - String Appstore category of the publisher app.
siteSubcategory - String Appstore subcategory of the publisher app.
siteBundle - String Bundle ID of the publisher app. Cannot be queried simultaneously with region, city, dma, zipCode, ad or adId.
source - String Name of the exchange in which ads were purchased.
sourceId - Int ID of the exchange in which ads were purchased.
dma - String DesignatedMarketArea describes where the consumers watch.
zipCode - String Identifies a particular postal delivery area.
campaignGoalType - String Identifies the goal type configured in the campaign.
campaignContractualGoalType - String Identifies the contractual goal type configured in the campaign.
rewarded - Int Ad category by rewarded.
skadConversionWindow - Int skad conversion window.
skadAnon - Int skad anonymity tier.
deviceType - String Identifies the type of the device (smartphone, tablet, unknown)
proxyType - String Identifies the type of the proxy
skoverlay - Int Identifies if the ad was shown on a skad overlay.
skippable - Int Identifies if the ad allowed to be skipped.
date - DateTime!
Arguments
granularity - Granularity
dateToStr - String! Returns a string formatted with given format based in JodaTime Java package
Arguments
formatString - String
dayOfWeek - String!
timeOfDay - Int!
impressions - Long Number of ad impressions shown.
clicks - Long Number of clicks on the ads.
cpc - Float Cost per click. Cost is defined as ad spend.
cpm - Float Cost per thousand impressions. Cost is defined as ad spend.
ctr - Float Click through rate.
spend - Float Amount of budget that was spent in that time period.
wins - Long Amount of bids that are won, only available for certain sources.
bidToWinRate - Float
uniqueImpressions - Long Has an error rate of 2% on the range of 0 to 1000M impressions,for values greater than 1000M the error rate becomes large and the metric unreliable.
uniqueClicks - Long Unique devices that have clicks 2% error.
skadAssistedInstalls - Long Amount of installs that were assisted by Jampp on skad devices.
uniqueEvents - Long Unique devices that have events.
Arguments
eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
events - Long Number of events attributed.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
assistedEvents - Long Events from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
assistedEventValue - Float Sum of purchase value related to a purchase event from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventValue - Float Sum of purchase value related to a purchase event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsCpa - Float Cost per event. Cost is defined as ad spend.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsRoas - Float Return over ad spend measured through attributed value in a purchase event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsIte - Float The percentage of every a thousand impressions that converted into an event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsRate - Float The amount of events divided by installs
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
installs - Long Number of attributed installs.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

hasCv - Boolean!

Number of SKAD installs that had a non-null conversion value in it's postback.

reinstall - Boolean!

Number of SKAD installs that had a reinstall=true in it's postback.
installsCpi - Float Cost per install. Cost is defined as ad spend.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
installsCvr - Float The percentage of clicks that converted into an install.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.
installsIti - Float The percentage of every a thousand impressions that converted into an install.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
assistedInstalls - Long Installs from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
uniqueEventsCpa - Float Cost per unique event. Cost is defined as ad spend.
Arguments
eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
Example
{
  "ad": "xyz789",
  "adParameter": "xyz789",
  "adId": 987,
  "adSet": "abc123",
  "adSetId": 123,
  "adSize": "xyz789",
  "adType": "xyz789",
  "adUrl": "xyz789",
  "advertiser": "xyz789",
  "advertiserId": 123,
  "advertiserBillingEntity": "abc123",
  "advertiserCountryId": 123,
  "app": "xyz789",
  "appBundle": "abc123",
  "appCategory": "xyz789",
  "appId": 123,
  "appPlatform": "ANDROID",
  "campaign": "abc123",
  "campaignParameter": "xyz789",
  "campaignId": 123,
  "campaignCountry": "xyz789",
  "campaignTrackerType": "MMP",
  "campaignType": "abc123",
  "campaignTypeId": 987,
  "city": "xyz789",
  "countryCode": "xyz789",
  "countryName": "abc123",
  "group": "abc123",
  "groupParameter": "xyz789",
  "groupId": 123,
  "region": "xyz789",
  "siteName": "abc123",
  "siteCategory": "abc123",
  "siteSubcategory": "abc123",
  "siteBundle": "abc123",
  "source": "xyz789",
  "sourceId": 987,
  "dma": "abc123",
  "zipCode": "abc123",
  "campaignGoalType": "xyz789",
  "campaignContractualGoalType": "xyz789",
  "rewarded": 123,
  "skadConversionWindow": 987,
  "skadAnon": 987,
  "deviceType": "abc123",
  "proxyType": "abc123",
  "skoverlay": 987,
  "skippable": 987,
  "date": "2007-12-03T10:15:30Z",
  "dateToStr": "abc123",
  "dayOfWeek": "xyz789",
  "timeOfDay": 987,
  "impressions": "2147483648",
  "clicks": "2147483648",
  "cpc": 123.45,
  "cpm": 123.45,
  "ctr": 987.65,
  "spend": 987.65,
  "wins": "2147483648",
  "bidToWinRate": 123.45,
  "uniqueImpressions": "2147483648",
  "uniqueClicks": "2147483648",
  "skadAssistedInstalls": "2147483648",
  "uniqueEvents": "2147483648",
  "events": "2147483648",
  "assistedEvents": "2147483648",
  "assistedEventValue": 987.65,
  "eventValue": 123.45,
  "eventsCpa": 987.65,
  "eventsRoas": 123.45,
  "eventsIte": 123.45,
  "eventsRate": 987.65,
  "installs": "2147483648",
  "installsCpi": 987.65,
  "installsCvr": 987.65,
  "installsIti": 987.65,
  "assistedInstalls": "2147483648",
  "uniqueEventsCpa": 987.65
}
Types

PivotTotals

Fields
Field Name Description
impressions - Long Number of ad impressions shown.
clicks - Long Number of clicks on the ads.
cpc - Float Cost per click. Cost is defined as ad spend.
cpm - Float Cost per thousand impressions. Cost is defined as ad spend.
ctr - Float Click through rate.
spend - Float Amount of budget that was spent in that time period.
wins - Long Amount of bids that are won, only available for certain sources.
bidToWinRate - Float
uniqueImpressions - Long Has an error rate of 2% on the range of 0 to 1000M impressions,for values greater than 1000M the error rate becomes large and the metric unreliable.
uniqueClicks - Long Unique devices that have clicks 2% error.
skadAssistedInstalls - Long Amount of installs that were assisted by Jampp on skad devices.
uniqueEvents - Long Unique devices that have events.
Arguments
eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
events - Long Number of events attributed.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
assistedEvents - Long Events from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
assistedEventValue - Float Sum of purchase value related to a purchase event from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventValue - Float Sum of purchase value related to a purchase event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsCpa - Float Cost per event. Cost is defined as ad spend.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsRoas - Float Return over ad spend measured through attributed value in a purchase event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsIte - Float The percentage of every a thousand impressions that converted into an event.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
eventsRate - Float The amount of events divided by installs
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
installs - Long Number of attributed installs.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.

hasCv - Boolean!

Number of SKAD installs that had a non-null conversion value in it's postback.

reinstall - Boolean!

Number of SKAD installs that had a reinstall=true in it's postback.
installsCpi - Float Cost per install. Cost is defined as ad spend.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
installsCvr - Float The percentage of clicks that converted into an install.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.
installsIti - Float The percentage of every a thousand impressions that converted into an install.
Arguments
attrSource - AttrSource!

Number of events attributed by either ALL, SKAD or MMP attribution sources. Default is ALL.

attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
assistedInstalls - Long Installs from users who were shown Jampp ads but were not attributed to Jampp.
Arguments
attrTouch - AttrTouch!

Number of events attributed to either ALL, CLICK or IMP attribution touch. Default is ALL.
uniqueEventsCpa - Float Cost per unique event. Cost is defined as ad spend.
Arguments
eventId - Int

ID of the event that will be used to calculate the total number of attributed events. If undefined, all events are aggregated.
Example
{
  "impressions": "2147483648",
  "clicks": "2147483648",
  "cpc": 123.45,
  "cpm": 987.65,
  "ctr": 987.65,
  "spend": 987.65,
  "wins": "2147483648",
  "bidToWinRate": 123.45,
  "uniqueImpressions": "2147483648",
  "uniqueClicks": "2147483648",
  "skadAssistedInstalls": "2147483648",
  "uniqueEvents": "2147483648",
  "events": "2147483648",
  "assistedEvents": "2147483648",
  "assistedEventValue": 123.45,
  "eventValue": 123.45,
  "eventsCpa": 987.65,
  "eventsRoas": 987.65,
  "eventsIte": 123.45,
  "eventsRate": 987.65,
  "installs": "2147483648",
  "installsCpi": 987.65,
  "installsCvr": 123.45,
  "installsIti": 123.45,
  "assistedInstalls": "2147483648",
  "uniqueEventsCpa": 123.45
}
Types

Platform

Description

OS name of the application that is being advertised (IOS/ANDROID).

Values
Enum Value Description

ANDROID

IOS
Example
"ANDROID"
Types

PlatformGenericFilter

Fields
Input Field Description
equals - Platform
notEquals - Platform
isIn - [Platform!]
isNotIn - [Platform!]
Example
{
  "equals": "ANDROID",
  "notEquals": "ANDROID",
  "isIn": ["ANDROID"],
  "isNotIn": ["ANDROID"]
}
Types

Status

Description

Status of the campaign.

Values
Enum Value Description

ACTIVE

PAUSED

ARCHIVED
Example
"ACTIVE"
Types

StatusGenericFilter

Fields
Input Field Description
equals - Status
notEquals - Status
isIn - [Status!]
isNotIn - [Status!]
Example
{
  "equals": "ACTIVE",
  "notEquals": "ACTIVE",
  "isIn": ["ACTIVE"],
  "isNotIn": ["ACTIVE"]
}
Types

StrGenericFilter

Fields
Input Field Description
equals - String
notEquals - String
isIn - [String!]
isNotIn - [String!]
Example
{
  "equals": "xyz789",
  "notEquals": "abc123",
  "isIn": ["xyz789"],
  "isNotIn": ["xyz789"]
}
Types

String

Description

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.

Example
"xyz789"
Documentation by Anvil SpectaQL