Retrieve city performance data with optional filters
GobbleCube Enterprise API FINAL (1.0.0)
All requests must include:
X-API-Key: Your API key (90-day expiry, managed through dashboard)Platform: Platform name (zepto)
API Key Management:
- API keys expire after 90 days
- Key generation and rotation managed through GobbleCube dashboard
- IP whitelisting supported for enhanced security
- Environment segregation at account level (production vs sandbox accounts)
Required Headers:
X-API-Key: Your API key for authenticationPlatform: Platform name (zepto)
Optional Headers:
X-Request-ID: Request ID for traceability (if not provided, one will be generated)
Response Headers:
X-Request-ID: Request ID for traceability and audit logging (always present)
- Campaign Management: Bulk creation, list, update, get details
- Keyword Management: Add, update, remove, bulk operations
- Product & City Management: Add/remove products, create groups
- Live Data: Keyword Share of Search (SOS) with real-time scraping
- T-1 Data: Detailed campaign performance metrics (yesterday's data)
- Job Management: Poll async job status, bulk job creation
Please contact your POC (Point of Contact) to get access to the Postman collection for faster integration and testing.
Rate Limits:
- Overall API: 200 requests per minute (RPM)
- Sliding Window: Rate limiting implemented using sliding window algorithm
- Per Application: Rate limits applied per API key/application
- Keyword SOS: 5 keywords every 15 minutes (per API key)
- Page Limit: Maximum page limit for all paginated GET APIs is 200 per page
Rate Limit Headers: When rate limits are approached or exceeded, the following headers are included in responses:
X-RateLimit-Limit: Maximum requests allowed per windowX-RateLimit-Remaining: Remaining requests in current windowX-RateLimit-Reset: Time when the rate limit window resets
Rate Limit Exceeded:
- HTTP Status:
429 Too Many Requests - Response includes retry-after information
- Implement exponential backoff for retries
Standard HTTP Status Codes:
200 OK- Successful request201 Created- Resource created successfully202 Accepted- Request accepted for async processing400 Bad Request- Invalid request parameters or payload401 Unauthorized- Missing or invalid API key403 Forbidden- Insufficient permissions404 Not Found- Resource not found429 Too Many Requests- Rate limit exceeded500 Internal Server Error- Server error502 Bad Gateway- Gateway error503 Service Unavailable- Service temporarily unavailable
Error Response Format:
{
"code": "ERROR_CODE",
"message": "Human-readable error message",
"details": "Additional error details (optional)"
}
Retry Logic:
- Safe to retry API calls with exponential backoff up to 3 times
- Use
X-Request-IDfrom response to track retries - Do not retry on 4xx errors (except 429 with retry-after)
- Retry on 5xx errors and network failures
- All operations support idempotency
- Duplicate request detection mechanism in place
- Use
X-Request-IDheader to ensure idempotency across retries - Same request with same
X-Request-IDwill return same result
- Requests are queued and processed based on workflow type priority
- For deterministic ordering requirements, contact support for guidance
- Campaign-level ordering can be configured if needed
Platform Sync:
- Two-way sync between GobbleCube and platform ad consoles
- Platform to GobbleCube sync: Maximum SLA of 3 hours
- Data accuracy maintained through continuous synchronization
T-1 Data:
- T-1 data represents yesterday's performance metrics
- Available through
GET /v1/t1-dataendpoint - Data is refreshed daily
Historical Data:
- Historical SOS snapshots available
- Live data available through API endpoints
Request Tracking:
- All requests return
X-Request-IDin response headers - Request ID used for logging and audit trail
- Include
X-Request-IDin support requests for faster resolution
Audit Trail:
- All API requests logged with: request ID, entity ID, timestamp, payload, response code
- Log retention: 90 days
- Audit trails available through request logs
Daily Summary Logs:
- Automated daily summary logs will be sent on email
- Includes all POST and GET activities
- Contact support for access
Version Policy:
- Current version:
v1 - Backward compatibility maintained across minor versions
- Major versions (breaking changes) released as new version endpoints
- 1 month deprecation notice period for breaking changes
- Communication via Slack channels for version updates
Versioning Strategy:
- Standard REST-based versioning
- Version included in URL path:
/v1/... - Future versions:
/v2/..., etc.
- Production:
https://enterprise-api.gobblecube.ai(Live )
Environment Segregation:
- Separate accounts for production and sandbox
- Same API endpoints, different account credentials
- IP whitelisting supported per environment
Data Encryption:
- Data encrypted in transit (TLS/HTTPS)
- Data encrypted at rest
- HTTP protocol not allowed (HTTPS only)
Data Isolation:
- Customer data in separate databases
- Role-based access control (RBAC) ensures Principle of Least Privilege (POLP)
- Cross-client data access prevented through architecture
Certifications:
- SOC2 Type II compliance
- Yearly penetration testing (next report: December 2026)
- MFA enabled by default (no password-based authentication)
Contact Support: Name: API Support Email: ishant.dahiya@gobblecube.ai
Download OpenAPI description
Languages
Servers
https://enterprise-api.gobblecube.ai
- https://enterprise-api.gobblecube.ai/v1/city-performance/data
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://enterprise-api.gobblecube.ai/v1/city-performance/data?snapshot_date=string&snapshot_date_from=string&snapshot_date_to=string&campaign_id=string&campaign_name=string&gc_campaign_type=string&campaign_status=string&targeting_type=string&targeting_value=string&match_type=string&product_id=string&bgr=string&city=string&page=1&limit=50&sort=string&order=asc' \
-H 'Platform: zepto'Response
application/json
{ "data": [ { … } ], "total": 410, "page": 1, "limit": 1, "total_pages": 410 }