Page tree
Skip to end of metadata
Go to start of metadata

Please Note: You should not share your API key with any partners. Your API key is for your account and your account only. It contains all your account data.  DO NOT SHARE IT WITH EXTERNAL PARTIES YOU DO NOT WANT HAVING ACCESS TO ALL YOUR DATA AND/OR CONTROL OF YOUR ACCOUNT.

Authentication

Authentication is currently handled by HTTP Basic Authentication over SSL. Your account admin can generate API credentials via the API Keys tab on their Account settings page.  The credentials consist of a Secret Key ID and a Secret Key that resemble the following:

Secret Key IDSecret Key
xxxxxxxxxxxxxxxxxxxxxxxxxxxxx1111111111111111111111111111111111111

For use in Basic Authentication, the Secret Key ID serves as the username and the Secret Key serves as the password.  

 

These values should be base64 encoded using the following format:

TypeExample
Unencodedxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:1111111111111111111111111111111111111
EncodedeHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHg6MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMQ==
Authorization Header Example

Reporting API

JSON Parsing Guidelines

The API is subject to change, in that new fields may be added at any time. Your JSON parsing should therefore be tolerant of new fields being added to the JSON. Please do not parse the JSON in a way that would not tolerate the addition of new fields.

Rate Limits

Unless otherwise permitted, all API users are subject to a rate limit of 30 queries per day (UTC).

Queries cannot be executed simultaneously.

Request

HTTP MethodEndpoint
POSThttps://api.lkqd.com/reports

The reporting request (POST) body is in the following JSON format:

Dimension Mapping

UI DimensionAPI Dimension
N/AOVERVIEW
Supply PartnerPARTNER

Supply Source

SITE
DomainDOMAIN
Detected DomainDETECTED_DOMAIN
App NameAPP_NAME
Bundle IDBUNDLE_ID
Supply Tag TypeSUPPLY_TAG_TYPE
LKQD Tag TypeLKQD_TAG_TYPE
Demand PartnerSOURCE
Demand OrderORDER
Demand DealDEAL
Demand TagTAG

Deal Start Date

DEAL_START_TS
Deal End DateDEAL_END_TS

Deal Delivery Goal

DEAL_DELIVERY_GOAL
Deal Front Load %DEAL_FRONT_LOAD_PERCENT
Demand Deal TypeDEAL_TYPE
Demand Delivery TypeTAG_AD_DELIVERY_TYPE
Demand Tag TypeTAG_TYPE
FormatFORMAT
EnvironmentENVIRONMENT
CountryCOUNTRY
Device TypeDEVICE
OSOS

Width X Height

PLAYER_WIDTH_HEIGHT
Custom 1CUSTOM1
Custom 2CUSTOM2
Custom 3CUSTOM3

 

Metric Mapping

UI Metric
API Metric
Available Report Types
Format LoadsFORMAT_LOADSSupply Only
Format Fill RateFORMAT_FILL_RATESupply Only
Ineligible Ops - DemandINELIGIBLE_OPS_DEMANDSupply Only
Ineligible Ops - RestrictionsINELIGIBLE_OPS_RESTRICTIONSSupply Only
OpportunitiesOPPORTUNITIESSupply Only
ImpressionsIMPRESSIONSSupply and Demand
Fill RateFILL_RATESupply Only
EfficiencyEFFICIENCYSupply and Demand
CPMCPMSupply and Demand
RevenueREVENUESupply and Demand
CostCOSTSupply and Demand
ProfitPROFITSupply and Demand
Profit MarginPROFIT_MARGINSupply and Demand
CTRCTR

Supply and Demand

25% View RateFIRST_QUARTILE_RATESupply and Demand
50% View RateMIDPOINT_RATESupply and Demand
75% View RateTHIRD_QUARTILESupply and Demand
100% View RateVTRSupply and Demand
ClicksCLICKSSupply and Demand
25% ViewsFIRST_QUARTILESSupply and Demand
50% ViewsMIDPOINTSSupply and Demand
75% ViewsTHIRD_QUARTILESSupply and Demand
100% ViewsCOMPLETED_VIEWSSupply and Demand
Ad StartsAD_STARTSSupply and Demand
Ad Starts RateAD_STARTS_RATESupply and Demand
Viewability Measured RateVIEWABILITY_MEASURED_RATESupply and Demand
Viewability RateVIEWABILITY_RATESupply and Demand
RequestREQUESTSDemand Only
VAST AdsVAST_ADSDemand Only
VPAID ResponsesVPAID_RESPONSESDemand Only
VPAID AttemptsVPAID_ATTEMPTSDemand Only
VPAID AdsVPAID_ADSDemand Only
WinsWINSDemand Only
VAST Ad RateVAST_AD_RATEDemand Only
VPAID Ad RateVPAID_AD_RATEDemand Only
Win RateWIN_RATEDemand Only
Tag TimeoutsTIMEOUTSDemand Only
Tag Timeout RateTIMEOUT_RATEDemand Only
Tag ErrorsERRORSDemand Only
Tag Error RAteERROR_RATEDemand Only
Playback ErrorsPLAYBACK_ERRORSDemand Only
Playback Error RatePLAYBACK_ERROR_RATEDemand Only

Response

If you Include one of the specified dimensions:

  • Demand Partner
  • Demand Order
  • Demand Deal
  • Demand Tag

The report will be considered a "Demand" report, for which a sample response is below (JSON):

 

Otherwise the report will be an "Supply" report - a sample response (JSON):

 

Applying Filters

Filtering by Multiple Values for the Same Dimension Using an OR Relationship.

This example shows how to filter for mutliple Supply Source IDs.  This will return records where the Supply Source ID is 105350 or 105351.

This example shows how to filter for Supply Sources that meet one of the specified requirements.  This will return records where the Supply Source ID is 105350 or "high" is in the Supply Source name.

 

Filtering by Multiple Values for the Same Dimension Using an AND Relationship.

This example shows how to filter for Supply Source IDs that meet both of the specified requirements.  This will return records where the Supply Source ID is 105350 and the Supply Source name includes "high" in it.

 

Filtering Values for Different Dimensions

This example shows how to filter for a specific Supply Source ID and a Country requirements.  This will return records where the Supply Source ID is 105350 and the Country is US.

  • No labels