These docs are for v1.9. Click to read the latest docs for v2.1.

Count Digital Passports for Target Audience

Before you begin

Get the count of digital passports passing a certain amount of parameters to reach the number of digital passports involved in your campaign.

Let's start πŸš€

Use the /onceOfMessage/countNFTs with the parameters you wish to get the count of.

πŸ“Œ

NFT Management Platform user rights required to call this API β†’ certRead

{
    "messageForm": {
        "tagRule": "all",
        "uniqueOwner": true,
        "tags": [],
        "tokenIds": "",
        "isWalletActiveSinceNumberOfDays": 30,
        "custodialWallet": "all",
        "allCountries": "false",
        "countries": ["France", "Atlantis"]
    }
}
InputMandatoryTypeDescription
tagRuleβœ…StringTag rules that define if your audience must own all mentioned tags or at least one.
or: The owner must have a digital passport with at least one defined tag.
and: The owner must have a digital passport that includes all specified tags.
all: All digital passports can be targeted independently of their tags or ID.
tokenIds: The owner must be one defined tokenId listed into the field tokenIds.
⚠️ The tokenIds filed is limited to 100,000 entries.
uniqueOwner❌Booleantrue: One message is sent per wallet even if your customer owns several digital passports.
tagsβœ…StringUse tags to target your audience.
If you do not define tags, set it as an empty [] array and use tokenIds to target your audience.
⚠️ Tags are case-sensitive.
tokenIds❌StringTarget specific digital passport IDs to send the campaign.
If you do not define tokenIds, use tags to target your audience.
Example: 123,345,456...
isWalletActiveSinceNumberOfDays❌NumberA period in days during which activity was observed on the user's wallet.
custodialWallet❌StringCustodial or non-custodial wallet.
yes: Send to custodial wallet only.
no: Send to non-custodial wallet only.
all: Both types of wallet.
allCountries❌Booleantrue: the digital passports must include the following defined countries.
false: the digital passports must include at least one of the defined countries.
countries❌StringDefine the target country.
String with values separated by a pipe
Example: France|Spain...
⚠️ Countries are case-sensitive.

Result: The count is returned.

{
    "count": 212
}