Get a campaign's commerce results

One campaign’s commerce results — revenue, ROAS, cart funnel, COD→prepaid conversion

GET /commerce/campaigns/{id}/analytics

Get a campaign's commerce results

cURL

curl --request GET \
  --url https://api.pineyard.ai/commerce/campaigns/{id}/analytics \
  --header 'Authorization: Bearer <token>'

200

{
  "range": "today",
  "window": {
    "from": "<string>",
    "to": "<string>",
    "previousFrom": "<string>",
    "previousTo": "<string>",
    "timezone": "Asia/Kolkata"
  },
  "orders": 123,
  "revenue": [
    {
      "currency": "<string>",
      "amount": "<string>"
    }
  ],
  "spendInr": 123,
  "roas": 123,
  "funnel": {
    "abandoned": 123,
    "outreachAttempted": 123,
    "reached": 123,
    "clicked": 123,
    "recovered": 123,
    "revenueAtRisk": [
      {
        "currency": "<string>",
        "amount": "<string>"
      }
    ],
    "rates": {
      "outreach": 123,
      "reached": 123,
      "clicked": 123,
      "recovered": 123
    }
  },
  "codToPrepaid": {
    "codOrders": 123,
    "codOrdersContacted": 123,
    "prepaidConfirmed": 123,
    "conversionRate": 123,
    "currency": "INR",
    "revenueShifted": 123,
    "paymentLinkClicks": 123,
    "rtoSavings": 123,
    "assumedRtoRatePct": 123
  }
}

Required scope: sales.view

Requires commerce analytics enabled for your workspace. Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Query Parameters

range · enum<string> · default: 30d

Available options: today, 7d, 30d, 90d

Response

200

application/json

OK

range · enum<string> · required

Available options: today, 7d, 30d, 90d

window · object · required

Show child attributes

orders · number · required

revenue · object[] · required

Show child attributes

spendInr · number · required

roas · number | null · required

funnel · object · required

Show child attributes

codToPrepaid · object · required

Show child attributes