Get the offer event

HTTP method	Endpoint
GET	/v1/offers/{offer_id}/offer_events

Path parameters

Parameter	Description
offer_id	The unique id for the offer.

Note: To change event status to active, you will need t to reset revenue and payout if previous value is null.

Query string parameters

Conditions	Parameters	Type	Description
Offset	offset	offset	Check page scale.
Limit	limit	limit	The number of date displays in each page.
Sort	sort	sort	Ranking according to the specified field ascending "+", or descending "-".
Filters	filters	filter	Query requirements of Specify field.
			EQUAL_TO NOT_EQUAL_TO LESS_THAN LESS_THAN_OR_EQUAL_TO GREATER_THAN GREATER_THAN_OR_EQUAL_TO CONTAINS NOT_CONTAINS NULL NOT_NULL
Fields	fields	field	You can choose the field of the query (the result of the query is in line with the selected field).
	id	integer	The unique id for the event.
	name	string	Offer Event name.
	revenue_type	string	Event revenue type. Allowed values: RPC · RPI · RPA · RPL · RPS · RPA+RPS
	revenue	string	Event revenue.
	percent_revenue	string	Event percent revenue.
	payout_type	string	Event payout type. Allowed values: CPC · CPI · CPA · CPL · CPS · CPA+CPS
	payout	string	Event payout.
	percent_payout	string	Event percent payout.
	status	string	The status of the event. Allowed values: active paused
	is_private	integer	Enabling this setting will track revenue of event only, affiliate do not have access to private events, custom affiliate payouts can not be set nor can 3rd party affiliate postbacks be placed. Allowed values: 1: Open 0: Close
	approve_conversions	integer	Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated. Allowed values: 1: Open 0: Close
	is_allowed_multiple	integer	Enabling this setting will allow multiple conversions to be recorded per user for only one click id. Allowed values: 1: Open 0: Close
	is_end_point	integer	Enabling this setting will close the active click session when this event is converted. Allowed values: 1: Open 0: Close
	conversion_protocol	integer	The Conversion tracking method to use for the offer event. Allowed values: 1 mage Pixel 2 ostback URL 3 Frame Pixel
	offer_payout_tier		Tier payout information.

Response body parameters

Field	Type	Description
id	integer	The unique id for the event.
name	string	Offer Event name.
revenue_type	string	Event revenue type. Allowed values: RPC · RPI · RPA · RPL · RPS · RPA+RPS
revenue	string	Event revenue.
percent_revenue	string	Event percent revenue.
payout_type	string	Event payout type. Allowed values: CPC · CPI · CPA · CPL · CPS · CPA+CPS
payout	string	Event payout.
percent_payout	string	Event percent payout.
status	string	The status of the event. Allowed values: active paused
is_private	integer	Enabling this setting will track revenue of event only, affiliate do not have access to private events, custom affiliate payouts can not be set nor can 3rd party affiliate postbacks be placed. Allowed values: 1: Open 0: Close
approve_conversions	integer	Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated. Allowed values: 1: Open 0: Close
is_allowed_multiple	integer	Enabling this setting will allow multiple conversions to be recorded per user for only one click id. Allowed values: 1: Open 0: Close
is_end_point	integer	Enabling this setting will close the active click session when this event is converted. Allowed values: 1: Open 0: Close
conversion_protocol	integer	The Conversion tracking method to use for the offer event. Allowed values: 1 mage Pixel 2 ostback URL 3 Frame Pixel
offer_payout_tier		Tier payout information.
tier_id	integer	The unique id for the tier.
tier_payout	string	Tier payout.
totalPages	integer	The list of data pages (associated with your limit).
totalRows	integer	Total number of available data.
offset	integer	The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.
limit	integer	The number of data displayed on one page

Example request

Request GET https://{networkname}.api.offerslook.com/v1/offers/102/offer_events?sort=+id&offset=1&limit=10&fields=id,name,offer_payout_tier,revenue,payout,status&filters[status][EQUAL_TO]=active

Request GET http://{networkname}.api.offerslook.com/v1/offers/102/offer_events?sort=+id&offset=1&limit=10&fields=id,name,offer_payout_tier,revenue,payout,status&filters[status][EQUAL_TO]=active

Example response

    {
      "code": 0,
      "message": "Success",
      "data": {
        "rowset": [
          {
            "id": 1,
            "name": "Initial Event",
            "revenue": "0.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": ""
          },
          {
            "id": 2,
            "name": "0",
            "revenue": "0.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": ""
          },
          {
            "id": 3,
            "name": "30",
            "revenue": "0.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": ""
          },
          {
            "id": 4,
            "name": "30d",
            "revenue": "0.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": ""
          },
          {
            "id": 5,
            "name": "30d",
            "revenue": "0.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": ""
          },
          {
            "id": 6,
            "name": "30ddd",
            "revenue": "0.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": ""
          },
          {
            "id": 7,
            "name": "30ddd",
            "revenue": "0.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": ""
          },
          {
            "id": 8,
            "name": "30ddd",
            "revenue": "0.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": ""
          },
          {
            "id": 9,
            "name": "30ddd",
            "revenue": "2.000",
            "payout": "0.000",
            "status": "active",
            "offer_payout_tier": [
              {
                "tier_id": 17,
                "offer_id": 102,
                "event_id": 9,
                "tier_payout": "0"
              }
            ]
          },
          {
            "id": 10,
            "name": "Update Test",
            "revenue": "2.800",
            "payout": "2.000",
            "status": "active",
            "offer_payout_tier": [
              {
                "tier_id": 12,
                "offer_id": 102,
                "event_id": 10,
                "tier_payout": "2.5"
              },
              {
                "tier_id": 11,
                "offer_id": 102,
                "event_id": 10,
                "tier_payout": "2.5"
              }
            ]
          }
        ],
        "totalPages": 1,
        "totalRows": 10,
        "offset": 1,
        "limit": 10
      }
    }