incrementCounter Mutation

Use the API to increment a Final value Brick

The incrementCounter mutation is designed to increment the final value counter 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.

Schema

GraphQL

type IncrementCounterResponse {
  success: Boolean!
}

type Mutation {
  incrementCounter(
    timestamp: DateTime!
    subscriptionId: String!
    brickId: String!
    count: Int!
  ): IncrementCounterResponse!
}

Mutation Parameters

Parameter	Type	Description
timestamp	DateTime!	The timestamp indicating when the counter incrementation occurs.
subscriptionId	String!	The uuid of the Salesbricks subscription associated with the customer. Obtain this value from the Public GraphQL API (also refered to as chain_id) and store it against your internal account ID for the customer.
brickId	String!	The uuid of the Salesbricks Brick to which the counter relates.
count	Int!	The number to increment the counter by (e.g., 1).

Response

The incrementCounter mutation returns a boolean labeled success. This response should be considered an empty response.

Example

GraphQL

mutation {
  incrementCounter(
    count: 1
    subscriptionId: "00000000-0000-0000-0000-000000000000"
    brickId: "00000000-0000-0000-0000-000000000000"
    timestamp: "2020-01-11T10:15:30Z"
  ) {
    success
  }
}

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 count are included in the mutation for desired counter incrementation.
• The count value can not be negative, and should be discrete (not the total amount).