Skip to content

Get Campaign and Consent Status

If you have created one or more campaigns:

Get all Campaigns

You can get the list of all campaigns by sending a GET request to /v1/campaigns/

The response includes a list of summaries of the campaigns that you have created and published.

Here is a sample response:

[
    {
        "id": "",
        "title": "campaign 1",
        "reviewer": null,
        "protectionLevel": null,
        "dataUsageDescription": null,
        "recipients": null,
        "publishTime": null,
        "expirationTime": null,
        "status": "Published"
    },
    {
        "id": "",
        "title": "capaign 2",
        "reviewer": null,
        "protectionLevel": null,
        "dataUsageDescription": null,
        "recipients": null,
        "publishTime": null,
        "expirationTime": null,
        "status": "Created"
    }
]

Get a Campaign by Id

You can get the details of one campaign by sending a GET request to /v1/campaigns/{campaignId}

The response includes all the values for creating the campaign as well as the following additional fields:

  • status: the status of the campaign. "Published" or "Created"
  • consentedCostumers the number of data owners that has accepted consent.

Here is a sample response:

{
    "id": "1cedbab1-6200-40c5-b3de-85727bd64d92",
    "title": "Sample campaign with reward",
    "reviewer": "",
    "protectionLevel": "AES",
    "dataUsageDescription": "Sample campaign with reward",
    "dataUsageDuration": "1",
    "dataUsageDurationUnit": "Hours",
    "status": "Published",
    "datasets": [
        {
            "datasetId": "8b8ab652-3160-41a2-a1d8-9f1c02fee97f",
            "name": "sample dataset",
            "columnNameEmailOwner": "EMAIL",
            "payloads": [
                {
                    "id": "1d315ece-2060-4591-9215-bf3eaa667800",
                    "attributes": [
                        {
                            "id": "075a3e76-58da-42ea-8f89-fc07b996c5bf",
                            "path": "TRANSACTIONS",
                            "fee": 0.00
                        },
                        {
                            "id": "f59f8ba3-0cc0-4776-a879-a7a54a161490",
                            "path": "CATEGORY",
                            "fee": 0.00
                        },
                        {
                            "id": "026d81da-2fc3-4a84-8271-7b262cdb5f15",
                            "path": "AMOUNT",
                            "fee": 0.00
                        }
                    ],
                    "conditions": [
                        {
                            "id": "c40f7980-09e1-4cb8-acec-a2dcddc18a14",
                            "columnName": "CATEGORY",
                            "operator": "EQUAL",
                            "value": "Misc"
                        }
                    ],
                    "recipients": [
                        {
                            "id": "cc7b0f7f-cfd1-4c05-a8bb-89567aa81d06",
                            "recipient": ""
                        }
                    ]
                }
            ],
            "rewards": [
                {
                    "id": "a681fa2c-d068-4766-ad71-347163708ad2",
                    "description": "dollars off monthly payments",
                    "quantity": "50"
                }
            ],
            "showMetaData": false,
            "consentedCostumers": 0
        }
    ]
}

You can get a report of data owners' consent status by sending a GET request to /v1/campaigns//status-report

The response is an excel file with a table of all data owners and their consent status. The file contains the following columns:

  • Campaign Name
  • Data Owner Email
  • Action: "Pending" or "Approved"
  • Action Time
  • Consented Dataset

Here is a sample table:

Campaign Name Data Owner Email Action Action Time Consented Dataset
campaign1 [email protected] Pending 2023-04-05 20:12:28 UTC dataset1
campaign1 [email protected] Approved 2023-04-05 21:09:10 UTC dataset1
Last update: April 5, 2023