Uber Developers

Uber

Developers

Ad Credits by Location Report

The Ad Credits by Location report provides Uber ad credit usage and remaining balance for each store location, allowing you to track how many credits each location has used and when its remaining credits expire.

Account types supported:

Account type	Supported
`OFD`	❌ (use Ad Credits report)
`USER_STORES_GROUP`	✅
`CPG`	❌
`NON_ENDEMIC_ADVERTISER`	❌
`AGENCY`	❌
`INTERNAL`	❌
`UNKNOWN`	❌

¶ Report Details

Report Type ID: AD_CREDITS_BY_LOCATION

Use Cases:

Store-level ad credit consumption tracking
Credit balance monitoring by location
Credit expiration planning

Dimensions:

location_id: Specific store/location identifier
currency_code: Currency for monetary values

Supported Time Units:

Time Unit	Async	Sync
`HOURLY`	❌	❌
`DAILY`	✅	✅
`WEEKLY`	✅	❌
`MONTHLY`	✅	❌
`SUMMARY`	❌	❌

¶ Available Metrics

credits_utilized
credits_available
expiry_date

credits_available and expiry_date are current values and do not vary by time period. They reflect each location’s balance at the time the report is generated, regardless of the time_range requested.

¶ Time Range Configuration

When configuring time ranges, follow these guidelines for proper aggregation:

Daily Reports

Start Date: Any valid date
End Date: Any valid date after start date
Example: "start_time": "2025-07-15T00:00:00Z", "end_time": "2025-07-20T00:00:00Z"

Weekly Reports

Start Date: Must be a Monday
End Date: Must be the next Monday
Example: "start_time": "2025-07-21T00:00:00Z", "end_time": "2025-07-28T00:00:00Z"

Monthly Reports

Start Date: Must be the first day of a month
End Date: Must be the first day of the next month
Example: "start_time": "2025-07-01T00:00:00Z", "end_time": "2025-08-01T00:00:00Z"

¶ Filter Operators

Supported operators: EQUAL, NOT_EQUAL, IN

¶ Sync Reporting Limitations

When using sync reporting for this report type, only the DAILY time unit is supported.

¶ Example Request (Async)

curl -X POST "https://api.uber.com/v1/ads/{account_id}/reporting/report" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Accept: application/json" \
  -d '{
    "report_type": "AD_CREDITS_BY_LOCATION",
    "time_range": {
      "start_time": "2025-07-21T00:00:00Z",
      "end_time": "2025-07-28T00:00:00Z"
    },
    "columns": [
      "location_id",
      "currency_code",
      "credits_utilized",
      "credits_available",
      "expiry_date"
    ],
    "filters": [
      {
        "column": "location_id",
        "operator": "IN",
        "values": ["65681a33-d4b2-4e23-b9a2-8e9fd44f0b60", "9ec56511-e1d6-4361-86b3-0e35f55fe24f"]
      }
    ],
    "time_unit": "WEEKLY",
    "file_format": "CSV"
  }'

¶ Example Response

{
  "report_id": "3a8d1f6e-9b2c-4e7a-a5d0-6c1f8e2b4d97"
}

¶ Example Request (Sync)

curl -X POST "https://api.uber.com/v1/ads/{account_id}/reporting/sync" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "report_type": "AD_CREDITS_BY_LOCATION",
    "time_range": {
      "start_time": "2025-11-03T00:00:00Z",
      "end_time": "2025-11-05T00:00:00Z"
    },
    "columns": [
      "location_id",
      "currency_code",
      "credits_utilized",
      "credits_available",
      "expiry_date"
    ],
    "filters": [
      {
        "column": "location_id",
        "operator": "IN",
        "values": ["b2e7d4a1-6f3c-4890-a5d8-1c9e0b7f3a62"]
      }
    ],
    "time_unit": "DAILY"
  }'