Support Ticket

API Endpoints

List of Campaign Event Tickets

Return list of campaign events

GET http://api.tyrads.com/publisher/campaigns/{campaignId}/support-tickets

Example:

get

Path parameters

campaignIdintegerRequired

Numeric ID of the campaign to get

Header parameters

X-Api-KeystringRequired

Publisher API Key

Example: YOUR_API_KEY

X-Api-SecretstringRequired

Publisher API Secret

Example: YOUR_API_SECRET

X-User-IDstringRequired

Publisher User ID

Example: YOUR_PUBLISHER_USER_ID

Responses

200

Status OK

application/json

get

HTTPcURLJavaScriptPython

GET /publisher/campaigns/{campaignId}/support-tickets HTTP/1.1
Host: api.tyrads.com
X-Api-Key: text
X-Api-Secret: text
X-User-ID: text
Accept: */*

200

Status OK

{
  "data": [
    {
      "id": 512552,
      "identifier": "Complete_Level_1",
      "eventName": "Complete Level 1",
      "eventDescription": null,
      "payoutTypeId": 2,
      "payoutType": "CPA",
      "payoutAmount": 2.55,
      "isTicketSubmitted": false,
      "eventCategory": "Complete tutorial",
      "ticketStatus": "new",
      "conversionStatus": "new"
    }
  ],
  "message": "OK"
}

Submit Support Ticket

Submit support ticket

GET http://api.tyrads.com/publisher/campaigns/{campaignId}/support-tickets/{id}

post

Path parameters

campaignIdintegerRequired

Numeric ID of the campaign to submit

idintegerRequired

Numeric ID of the campaign event to submit

Header parameters

X-Api-KeystringRequired

Publisher API Key

Example: YOUR_API_KEY

X-Api-SecretstringRequired

Publisher API Secret

Example: YOUR_API_SECRET

X-User-IDstringRequired

Publisher User ID

Example: YOUR_PUBLISHER_USER_ID

Body

orderIdstring | nullableOptional

The Order ID. Required if the event has category Purchased

gamePlayerIdstringOptional

The Game Player ID.

imagestring · binaryOptional

The screenshot image.

Responses

200

Status OK

application/json

404

Some resource are not found (e.g Install Conversion)

application/json

post

HTTPcURLJavaScriptPython

POST /publisher/campaigns/{campaignId}/support-tickets/{id} HTTP/1.1
Host: api.tyrads.com
X-Api-Key: text
X-Api-Secret: text
X-User-ID: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 57

{
  "orderId": "text",
  "gamePlayerId": "text",
  "image": "binary"
}

{
  "data": {
    "id": 1234
  },
  "message": "OK"
}

API References

Campaign Events

Attribute	Type	Description
id	integer	Campaign Publisher Event ID
identifier	string	Campaign event identifier
eventName	string	Campaign event name
eventDescription	string	Campaign event description
payoutTypeId	integer	ID of payout type
payoutType	string	Payout type name
payoutAmount	float	Campaign event payout amount
isTicketSubmitted	boolean	Is ticket submitted
eventCategory	string	Event category name
ticketStatus	string	Ticket status new, approved, or rejected
conversionStatus	string	Conversion status approved, rejected, pending, invalid, flagged