mutation {
  setGauge(
    timestamp: "2020-01-11T10:15:30Z"
    subscriptionId: "00000000-0000-0000-0000-000000000000"
    brickId: "00000000-0000-0000-0000-000000000000"
    value: 1
  ) {
    success
  }
}
type SetGaugeResponse {
  success: Boolean!
}

type Mutation {
  setGauge(
    timestamp: DateTime!
    subscriptionId: String!
    brickId: String!
    value: Int!
  ): SetGaugeResponse!
}

The setGauge mutation is designed to increment the prorated gauge for a specific customer in Salesbricks.

To utilize this mutation, follow the authentication steps outlined in the Authentication guide, and ensure that you are using the Usage API Endpoint.

Mutation Parameters

timestamp
DateTime
required

The timestamp indicating when the gauge is set.

subscriptionId
String
required

The UUID of the Salesbricks subscription associated with the customer.

Obtain this value from the Public GraphQL API and store it against your internal account ID for the customer.

brickId
String
required

The UUID of the associated Usage Brick.

value
Int
required

The number to set the gauge value to (e.g. 1).

Response

success
Boolean
required

This response should be considered an empty response.

Important Notes

  • To prevent duplicate requests and avoid over-charging customers, refer to the Idempotent Requests guide.
  • Ensure accurate values for timestamp, subscriptionId, brickId, and value are included in the mutation for desired gauge set.
  • The value parameter cannot be negative, and shouldn’t be discrete (it should be the total/aggregated value).
mutation {
  setGauge(
    timestamp: "2020-01-11T10:15:30Z"
    subscriptionId: "00000000-0000-0000-0000-000000000000"
    brickId: "00000000-0000-0000-0000-000000000000"
    value: 1
  ) {
    success
  }
}
type SetGaugeResponse {
  success: Boolean!
}

type Mutation {
  setGauge(
    timestamp: DateTime!
    subscriptionId: String!
    brickId: String!
    value: Int!
  ): SetGaugeResponse!
}