Contents x
      BulkExportAudiences
      • 1 Minute to read
      • Print
      • Dark
        Light
      • PDF
      Contents

      BulkExportAudiences

      • 1 Minute to read
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Exports all audiences of specified status into appended files of a specified size 

      KeyValue(s)Description
      method"BulkExportAudiences"Exports all audiences of specified status into appended files of a specified size
      fileStub"fileStubString"Each file that is generated will have a filename beginning with the "fileStubString".
      The location of the export files is determined by the project's campaign definition file.
      status"statusString"Optional Filter.  Available status:
      • *  (All)
      • draft
      • live
      • ended
      • cancelled
      prefix"prefix string"Optional prefix added to start of each hashkey as part of export. e.g.,
      US\t
      will generate
      US 23c4ga5678639ca72520a257cf5760a1dfbd35ea558d66766f4d404d185f9
      suffix"suffix string"Optional suffix added to end of each hashkey as part of export.  e.g.,
      \t%AUDIENCEID%
      will generate
      23c4ga5678639ca72520a257cf5760a1dfbd35ea558d66766f4d404d185f9     27988405173

      Note: the following read-only variables are supported:
      • %AUDIENCEID%
      • %
      recordsPerFileNNNNNNOptional.  Number of records to be included in each file.
      Default = {TODO}
      user"username"
      		Optional Filter.  Last Modified By username
      archiveStatus"statusString"Optional Filter.  Available status:
      • *  (All)
      • active
      • archived
      creator"username"

      		Optional Filter.   Created by username.

      For each audience in the search, obtains the unique hash-keys that are in the audience and outputs to file.   Data from multiple audiences may be appended into the same file - to identify which audience a key belongs to, use %AUDIENCEID% as either a prefix or suffix.

        {
    "method": "BulkExportAudiences",
    "fileStub": "testexport",
    "status": "*",
    "prefix": "US\t",
    "suffix": "\t%AUDIENCEID%",
    "recordsPerFile": 50000,
    "project": "eyeota"
  }



       {
    "method": "BulkExportAudiences",
    "user": "smc@datajetsoft.com",
    "fileStub": "testexport",
    "prefix": "US\t",
    "suffix": "\t%AUDIENCEID%",
    "recordsPerFile": 50000,
    "project": "eyeota"
  }

      Sample Return

      {
    "files": 1,
    "totalLinesWritten": 0,
    "audiencesExported": 0,
    "audiencesFailed": 0,
  }


      {
    "files": 7,
    "totalLinesWritten": 322924,
    "audiencesExported": 6,
    "audiencesFailed": 0,
}
      Was this article helpful?
      What's Next