Versions API - Ours Privacy

Manage configuration versions. Create, list, find, and update versions to publish destination, source, and mapping changes to your live deployment.

Manage configuration versions. Create, list, find, and update versions in your account.

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

limit?|

Maximum number of items to return. Defaults to 25; values below 1 are clamped to 1 and values above 100 are clamped to 100.

cursor?string

Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.

isPublished?|

Filter to only published or unpublished versions.

nameContains?string

Case-insensitive substring match on the version name.

notesContains?string

Case-insensitive substring match on the version notes.

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/versions"

{
  "entities": [
    {
      "id": "string",
      "name": "string",
      "versionNumber": 0,
      "isPublished": true,
      "notes": "string",
      "createdAt": "string",
      "publishedAt": "string"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

includeAllowedEvents?array<>|

Cherry-pick: allowed event ids (slug-like strings) to include from the draft. Omit or send [] to include all draft changes in this collection.

includeConsentSettings?array<>|

Cherry-pick: consent settings ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeDestinations?array<>|

Cherry-pick: destination UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeExternalAllowedEventData?array<>|

Cherry-pick: external allowed event data ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeGlobalDispatchCenters?array<>|

Cherry-pick: global dispatch center ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeMappings?array<>|

Cherry-pick: mapping ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeReplaySettings?array<>|

Cherry-pick: replay settings ids to include from the draft. Omit or send [] to include all draft changes in this collection.

includeSources?array<>|

Cherry-pick: source UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeTagManagerTags?array<>|

Cherry-pick: tag manager tag UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeTagManagerTriggers?array<>|

Cherry-pick: tag manager trigger UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeTagManagerVariables?array<>|

Cherry-pick: tag manager variable UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeDataGovernanceRules?array<>|

Cherry-pick: data governance rule UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeDataGovernanceEvents?array<>|

Cherry-pick: data governance event UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeExperimentSettings?array<>|

Cherry-pick: experiment settings UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeExperiments?array<>|

Cherry-pick: experiment UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

includeExperimentVariants?array<>|

Cherry-pick: experiment variant UUIDs to include from the draft. Omit or send [] to include all draft changes in this collection.

name?|

notes?|

Response Body

`application/json`

curl -X POST "https://app.oursprivacy.com/rest/v1/versions" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "name": "string",
  "versionNumber": 0,
  "isPublished": true,
  "notes": "string",
  "createdAt": "string",
  "publishedAt": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/versions/string"

{
  "id": "string",
  "name": "string",
  "versionNumber": 0,
  "isPublished": true,
  "notes": "string",
  "createdAt": "string",
  "publishedAt": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|

notes?|

Response Body

`application/json`

curl -X PATCH "https://app.oursprivacy.com/rest/v1/versions/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "name": "string",
  "versionNumber": 0,
  "isPublished": true,
  "notes": "string",
  "createdAt": "string",
  "publishedAt": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://app.oursprivacy.com/rest/v1/versions/string/publish"

{
  "id": "string",
  "name": "string",
  "versionNumber": 0,
  "isPublished": true,
  "notes": "string",
  "createdAt": "string",
  "publishedAt": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/versions/string/snapshot"

{
  "id": "string",
  "versionNumber": 0,
  "jsonContent": {}
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Authorization

apiKey

AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*|

Query Parameters

against?string

Baseline version id to compare the path version against. Omit for the latest published version. Pass a version UUID to compute a version-vs-version diff.

Formatuuid

Response Body

`application/json`

curl -X GET "https://app.oursprivacy.com/rest/v1/versions/draft/diff"

{
  "count": 0,
  "differences": {
    "destinations": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "sources": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "allowedEvents": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "externalAllowedEventData": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "mappings": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "consentSettings": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "globalDispatchCenters": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "replaySettings": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "tagManagerTags": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "tagManagerTriggers": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "tagManagerVariables": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "dataGovernanceRules": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "dataGovernanceEvents": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "experimentSettings": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "experiments": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    },
    "experimentVariants": {
      "added": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "removed": [
        {
          "id": "string",
          "name": "string",
          "summary": "string",
          "tagManagerId": "string"
        }
      ],
      "modified": [
        {
          "old": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          },
          "new": {
            "id": "string",
            "name": "string",
            "summary": "string",
            "tagManagerId": "string"
          }
        }
      ]
    }
  }
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

Versions

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`