Skip to main content

OfferGoal

References an offer goal.

type OfferGoal {
  id: String!
  amount: Float!
  payout_usd: Float!
  non_linear: Boolean!
  is_purchase_goal: Boolean!
  is_attribution: Boolean!
  description: String
  name: String
  order: Int
  maximum_completion_time_days: Int
  is_completed: Boolean!
  completed_at: String
}

Fields

`OfferGoal.id` ● `String!` non-null scalar

The unique id for the offer goal.

Example: "123456789012345678"

`OfferGoal.amount` ● `Float!` non-null scalar

The amount of virtual currency awarded to the user for completing the goal.

Example: 25

`OfferGoal.payout_usd` ● `Float!` non-null scalar

The potential payout for a goal's completion by a player.

Example: 0.25

`OfferGoal.non_linear` ● `Boolean!` non-null scalar

Indicates whether the offer goal is linear or non-linear.

Example: true

`OfferGoal.is_purchase_goal` ● `Boolean!` non-null scalar

Indicates whether the offer goal is a purchase goal.

Example: true

`OfferGoal.is_attribution` ● `Boolean!` non-null scalar

Indicates whether the offer goal is an attribution goal.

Example: false

`OfferGoal.description` ● `String` scalar

The description of the offer goal.

Example: "Complete task 1"

`OfferGoal.name` ● `String` scalar

The name of the offer goal.

Example: "Task 1"

`OfferGoal.order` ● `Int` scalar

The linear order of the goal to be completed.

Example: 1

`OfferGoal.maximum_completion_time_days` ● `Int` scalar

The maximum number of days a player has to complete the goal. Null when no completion window is configured.

Example: 7

`OfferGoal.is_completed` ● `Boolean!` non-null scalar

Whether the player has completed this goal.

Always false on the offers query, which describes offers the player has not engaged with.

Example: true

`OfferGoal.completed_at` ● `String` scalar

When the player completed this goal. Null unless is_completed is true.

Example: "2026-08-14T09:12:44Z"

Member Of

Offer object ● PlayerOffer object

Fields
Member Of