Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel2

Get a customer

Method

GET

Path

/api/customer/index

 

Usage

This endpoint finds a customer by its ID

 

Parameters

NameTypeRequiredDescription
idnumberYID of the customer

Example cURL

Code Block
curl -X GET \
  'https://platform.flxone.com/api/customer/index?id=1' \
  -H 'Cache-Control: no-cache' \
  -H 'X-AUTH: of07jlipnrb38d9h4ridodg0f79ncnpi9j6qb1us1mgb04ijre4om7eu93d1bodj28v7gjq3o5ngukti3ahm4jk78a2j8m68pvivnp1' \
  -H 'X-CSRF: bc2fee7ec20fda47e32e674f2a668ca3'

Output

Code Block
{
    "response": {
        "status": "OK",
        "customer": {
            "id": "1",
            "name": "Blue Mango",
            "enabled": "yes",
            "dataStorageType": "appnexus-s3",
            "dataStorageUsername": "AKIAIO63EDAEHADDK53EGA",
            "dataStoragePassword": "NUAdDAQmGS12ABUTXhsmKBAYeGs1DA==",
            "dataStorageLocation": "data-siphon",
            "dataStorageFolder": null,
            "dataStorageFolderFeedDynamic": null,
            "dataStorageFormat": "default",
            "dataStorageFormatRegex": null,
            "dataStorageFormatDateRegex": null,
            "dataChecksumValidation": "1",
            "dataFeeds": "standard_feed,segment_feed,go_customer_columnar",
            "appNexusDataType": "loglevel",
            "appNexusPermissions": "readwrite",
            "importLookBehindHours": "96",
            "aggregation": "1",
            "hiveDatabase": "flxone",
            "hivePriority": "HIGH",
            "apiProxy": "1",
            "flxVizClusterId": "1",
            "apiProxyName": "bluemango",
            "apiProxyUsername": "ME0/IyaserbBEBLBs8AA==",
            "apiProxyPassword": "GxQ7NX4hYT4bRtPlw5D0hYfLCUNIS03ZzwqK08oMXoRLxMrVyVNOw==",
            "useSandbox": null,
            "datacenterId": "2"
        }
    }
}

Get a list of customers

Method

GET

Path

/api/customer/list

 

Usage

This endpoint finds all enabled customers

 

Example cURL

Code Block
curl -X GET \
  https://platform.flxone.com/api/customer/list \
  -H 'Cache-Control: no-cache' \
  -H 'X-AUTH: of07jlipnrb38d9h4ridodg0f79ncnpi9j6qb1us1mgb04ijre4om7eu93d1bodj28v7gjq3o5ngukti3ahm4jk78a2j8m68pvivnp1' \
  -H 'X-CSRF: bc2fee7ec20fda47e32e674f2a668ca3'

Output

Code Block
{
    "response": {
        "status": "OK",
        "customers": [
            {
                "id": "1",
                "name": "Blue Mango",
                "enabled": "yes",
                "dataStorageType": "appnexus-s3",
                "dataStorageUsername": "AKIAIOAADF8UGCDK53EGA",
                "dataStoragePassword": "NUAdDAQadermGS12ABUiPTA7mIjBTXhsmKBAYeGs1DA==",
                "dataStorageLocation": "data-siphon",
                "dataStorageFolder": null,
                "dataStorageFolderFeedDynamic": null,
                "dataStorageFormat": "default",
                "dataStorageFormatRegex": null,
                "dataStorageFormatDateRegex": null,
                "dataChecksumValidation": "1",
                "dataFeeds": "standard_feed,segment_feed,go_customer_columnar",
                "appNexusDataType": "loglevel",
                "appNexusPermissions": "readwrite",
                "importLookBehindHours": "96",
                "aggregation": "1",
                "hiveDatabase": "flxone",
                "hivePriority": "HIGH",
                "apiProxy": "1",
                "flxVizClusterId": "1",
                "apiProxyName": "bluemango",
                "apiProxyUsername": "ME0/IyUSPASD585aBLBs8AA==",
                "apiProxyPassword": "GxQ7NX4ha312ad3ljdctPlw5DgaEhYfLCUNIS03ZzwqK08oMXoRLxMrVyVNOw==",
                "useSandbox": null,
                "datacenterId": "2"
            },
            {
                "id": "4",
                "name": "GDM",
                "enabled": "yes",
                "dataStorageType": "none",
                "dataStorageUsername": "AKIAJ6LJEIYGEY25USA",
                "dataStoragePassword": "GEY7KQMyfzMBBRNaOAAleiekR8JAzAZAiAvLFQ3E3kPBg==",
                "dataStorageLocation": "flxviz-gdm",
                "dataStorageFolder": null,
                "dataStorageFolderFeedDynamic": null,
                "dataStorageFormat": "default",
                "dataStorageFormatRegex": null,
                "dataStorageFormatDateRegex": null,
                "dataChecksumValidation": "1",
                "dataFeeds": "go_customer_columnar",
                "appNexusDataType": "loglevel",
                "appNexusPermissions": "readwrite",
                "importLookBehindHours": "96",
                "aggregation": "1",
                "hiveDatabase": "gdm",
                "hivePriority": "HIGH",
                "apiProxy": "1",
                "flxVizClusterId": "6",
                "apiProxyName": "gdm",
                "apiProxyUsername": "NUUnGSASEQA==",
                "apiProxyPassword": "EGkicDAZAa36lwiEFR1tYKlhyLTlgFhJ4FRZMfxE=",
                "useSandbox": null,
                "datacenterId": "2"
            }
        ]
    }
}