Mutations

List mutations

Lists your organization's Mutations, newest first.

One page at a time: limit rows at most, 100 by default. When the answer holds nextCursor, more rows exist: send it back as cursor to get the next page. When it is absent, you have the last page. The cursor is opaque: send it back with no change, and do not build one.

A row that is still running is checked against the change itself as the page is read, so a Mutation that finished after its row was written shows its true outcome here.

This is the history read, and it needs mutation:read. Starting a Mutation and polling the one you started need mutation:write.

get/mutations

Request

  • Base URL: https://api.adcrunch.dev
  • URL: https://api.adcrunch.dev/mutations
  • Auth: HTTP bearer

Query parameters

cursorstring

The nextCursor of the previous page. Omit it to get the first page. Send it with no change, and with the same filters as the request that answered it: a cursor from a different query gets a 400 invalid_cursor. Do not build or change a cursor.

limitinteger required

The greatest number of rows on the page, from 1 to 500. The default is 100. A greater value gets a 400, with error of invalid_request.

Response

One page of Mutations, newest first. This one is the last page, so it carries no nextCursor.

nextCursorstring

Send this value as cursor to get the next page. It is absent on the last page.

Example response

{
  "data": [
    {
      "action": {
        "dailyBudget": 50,
        "kind": "meta_create_campaign",
        "name": "Spring sale prospecting",
        "objective": "OUTCOME_SALES",
        "specialAdCategories": []
      },
      "advertiserId": "acc_1203456789012345",
      "completedAt": null,
      "createdAt": 1790000060000,
      "organizationId": "org_3a7f10",
      "priorValue": null,
      "provider": "meta",
      "result": null,
      "status": "running",
      "tool": "meta_create_campaign",
      "userId": "usr_4e8b23",
      "workflowId": "7e5a2d19-0c4b-4e6a-8f31-5b9d7a02c6e8"
    },
    {
      "action": {
        "id": "120210000000000",
        "kind": "meta_set_status",
        "level": "campaign",
        "status": "PAUSED"
      },
      "advertiserId": "acc_1203456789012345",
      "completedAt": 1790000004000,
      "createdAt": 1790000000000,
      "organizationId": "org_3a7f10",
      "priorValue": {
        "status": "ACTIVE"
      },
      "provider": "meta",
      "result": {
        "ok": true,
        "result": {
          "success": true
        }
      },
      "status": "complete",
      "tool": "meta_set_status",
      "userId": "usr_4e8b23",
      "workflowId": "b3d1f0c4-6a2e-4a1f-9f77-2c0d1e5a8b94"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.