Order Endpoint

Introductionback to top

Use this endpoint to retrieve your order data. All requests require your clientId. You can find your clientId under the Account Profile section when you login to your GPN account.

This endpoint supports the following dimensions

URLback to top

https://partner-api.groupon.com/reporting/v2/order

Supported Formatsback to top

  • JSON
  • XML (default)
  • CSV

Sample Callsback to top

Sample Requests

Retrieve all my daily order data for the year 2014, filtered by USD currency. This effectively groups by day.

https://partner-api.groupon.com/reporting/v2/order.json?clientId=01faac2db87949ba744486af455c30e03662bd78&group=date&date=[2014-01-01&date=2014-12-31]&campaign.currency=USD

Retrieve all my deal permalink data for the year 2014, filtered by USD currency.

https://partner-api.groupon.com/reporting/v2/order.json?clientId=01faac2db87949ba744486af455c30e03662bd78&group=deal|date&date=[2014-01-01&date=2014-12-31]&campaign.currency=USD

Retrieve all my data grouped by TopCategory for the year 2014, filtered by USD currency

https://partner-api.groupon.com/reporting/v2/order.json?clientId=01faac2db87949ba744486af455c30e03662bd78&group=TopCategory&date=[2014-01-01&date=2014-12-31]&campaign.currency=USD

Retrieve all my daily data for the year 2014 grouped by the TopCategory local, filtered by USD currency

https://partner-api.groupon.com/reporting/v2/order.json?clientId=01faac2db87949ba744486af455c30e03662bd78&group=deal|date&date=[2014-01-01&date=2014-12-31]&campaign.currency=USD&TopCategory.TopCategoryUuid=c09790ba-a6b9-40fc-ad81-4cdf25260b5e

Retrieve all my data grouped by Platform for the year 2014, filtered by USD currency

https://partner-api.groupon.com/reporting/v2/order.json?clientId=01faac2db87949ba744486af455c30e03662bd78&group=Platform&date=[2014-01-01&date=2014-12-31]&campaign.currency=USD

Retrieve all my daily data for the year 2014 grouped by the Platform WEB, filtered by USD currency

https://partner-api.groupon.com/reporting/v2/order.json?clientId=01faac2db87949ba744486af455c30e03662bd78&group=Platform|deal|date&date=[2014-01-01&date=2014-12-31]&campaign.currency=USD&Platform=WEB

Measuresback to top

The following measures are supported by the campaign endpoint.

Name Type Description
SaleGrossAmount Decimal Sales gross amount in currency units
NumberOfUnits Integer Number of units buy in this sale
LedgerAmount Decimal Ledger debit minus ledger credit in currency units
LedgerCredit Decimal Ledger debit in currency units
LedgerDebit Decimal Ledger credit in currency units
LedgerCount Integer Count of ledger entry (typical 1 for sale 2 for refund)

Dimensionsback to top

The following dimensions are supported by the order endpoint.

Dimension Name Default Search Default Grouping Description Mandatory
Order billing id id The order billing id uniquely identifies the sale No
Campaign name id The campaigns. This dimension is a leaf linked to the media No
Media name id The medias No
TopCategory name TopCategoryName The top level category No
Platform name Platform The platform of the sale No
Deal permalink permalink The deals No
Date datetime datetime The date/time dimension with a granularity level of one hour Yes

Order

Information Name Type Description
BillingId String The order billing id uniquely identifies the sale of a deal on Groupon.com.
Sid String The SID or Sub-Affiliate ID is an additional ID parameter that can be defined by a partner to faciliate additional tracking in their report.
Wid String The WID or Website ID is an additional ID parameter that can be defined by a partner to faciliate additional tracking in their reports.
Country String The order Country (Iso Code)
Currency String The order Currency (Iso code)
Status String The order status (Possible values: VALID,REFUNDED,INVALID)

Campaign

Information Name Type Description
Name String The campaign name
Country String The campaign country (iso code)
Currency String The campaign currency (Iso code)
LandingURL String The campaign landing url
Type String The campaign type (possible values: FIXED, CAT, RSS, BOOKMARKLET)
Status String The campaign status (possible values: ACTIVE, INACTIVE)

Media

Information Name Type Description
Name String The media name
Type String The media type (possible values: TEXT, IMAGE, CAT, RSS, BOOKMARKLET)
Status String The media status (possible values: ACTIVE, INACTIVE)

TopCategory

Information Name Type Description
TopCategoryName String The name of the top category
TopCategoryUuid String The groupon identifier used for the top category. Use this when filtering top level categories.

Platform

Information Name Type Description
Platform String The name of the platform. Possible values:
  • WEB: Desktop Website
  • TOUCH: Mobile Website
  • APP: Mobile App
  • UNKNOWN: Not Available
    Please note that platform information is not available for clicks and sales before October 16th 2014.

Deal

Information Name Type Description
PermaLink String The deal permalink uniquely identifies a Groupon deal.

Date

Information Name Type Description
Day Date The day
Datetime Datetime The day and hour
Year Integer The Year
Month String The month in year (eg: 2014-07)
MonthName String The month name (eg: July)
MonthNum Integer The month number (eg: 7)
DayOfMonth Integer The day in the month (eg 15 for 15th July 2014)
DayOfWeek Integer The day in the week (1 for Sunday)
DayOfWeekName String The day of week name
HourOfDay Integer The hour in the day (00 to 23)