TIXY Private Organizer API Quickstart
Overview
The TIXY Private Organizer API provides a comprehensive set of endpoints for event organizers to manage their events, access sales reports, retrieve statistics, and handle marketing insights. This API is designed to give you deep insights into your events and tours.Authentication
To access the Private Organizer API, you need to use a Bearer token authentication method:- Authentication Type: Bearer Token
- Header Format:
Authorization: Bearer <your_access_token>
Obtaining Access Token
Obtain your private API access token in your panel on TIXY platform. Each token is unique to your organization and provides secure access to your event data.Base URL
API Endpoints
The Private Organizer API is organized into several key categories:Sales Endpoints
-
Event Sales Reports
- Retrieve sales report for a specific event
- Retrieve sales reports for events by status
- Endpoint:
/sales/event/{id},/sales/events/{status}
-
Tour Sales Reports
- Retrieve sales data for a specific tour
- Retrieve sales reports for tours by status
- Endpoint:
/sales/tour/{id},/sales/tours/{status}
-
Sales Terms
- Get detailed sales terms and fees
- Endpoint:
/sales/terms
Statistics Endpoints
-
Event Statistics
- Retrieve ticket statistics for events
- Endpoint:
/statistics/events/{status},/statistics/event/{id}
-
Tour Statistics
- Retrieve ticket statistics for tours
- Endpoint:
/statistics/tours/{status},/statistics/tour/{id}
-
Device Statistics
- Analyze device usage for events and tours
- Endpoint:
/marketing/devices/{id}
-
Geographic Statistics
- Understand audience geographic distribution
- Endpoint:
/marketing/geography/{id}
Marketing Insights Endpoints
- Marketing Consent
- Retrieve marketing consent data for events and tours
- Endpoints:
/marketing/clients-granted-consent/events/{status}/marketing/clients-granted-consent/tours/{status}/marketing/clients-granted-consent/event/{id}/marketing/clients-granted-consent/tour/{id}
Example Request
Here’s an example of retrieving sales report for a specific event:Error Handling
The API uses standard HTTP status codes:200 OK: Successful request400 Bad Request: Invalid parameters401 Unauthorized: Authentication failed404 Not Found: Resource not found500 Internal Server Error: Server-side error
code: A machine-readable error codemessage: A human-readable error description
Rate Limits
- Requests are limited to prevent abuse
- Contact TIXY support for specific rate limit details