Service moteur de requête

Vue d’ensemble

L’API et les services Yield Analytics sont exposés via une interface REST. Il est destiné à faciliter le développement de fonctionnalités personnalisées aux développeurs expérimentés avec les plateformes de développement web 2.0, AJAX, REST et orientées service. Les développeurs doivent connaître les paradigmes d’application web, notamment AJAX, XML, JSON et le protocole HTTP(S) avant de tenter de développer avec l’API et les services Yield Analytics.

Le service Moteur de requête permet au développeur d’API d’accéder à un moteur très flexible pour interroger des données à partir du système Yield Analytics afin d’accomplir des cas d’usage non pris en compte avec les API De découverte de produits et d’inventaire. Bien que la flexibilité et la puissance du service moteur de requête permettent d’accomplir de nombreux cas d’usage, seuls les utilisateurs ayant des connaissances approfondies doivent tenter de former une requête moteur de requête pour s’assurer que des données valides sont extraites. Contactez votre contact du service clientèle Yield Analytics pour vous aider à développer les expressions de requête requises pour atteindre votre objectif de données.

Types de contenu

L’API REST de service est actuellement conçue pour prendre en charge le type de contenu suivant :

JSON - utilisation de Content-type: application/json

La sélection du type de contenu souhaité est un choix que le développeur d’API doit faire au cas par cas. La fonctionnalité d’API est symétrique entre les types de contenu. Les développeurs d’API peuvent spécifier le type de contenu souhaité dans les paramètres de la méthode HTTP GET ou POST ou via leur bibliothèque de client AJAX ou HTTP.

Vérification des erreurs et codes status

Les développeurs d’API doivent case activée les codes de réponse HTTP retournés par l’API REST du service pour détecter les erreurs propagées à partir des appels d’API. Les appels réussis au service entraînent l’utilisation de 200 codes de réponse de plage. Les réponses HTTP de plage 400 et 500 indiquent des erreurs. Les codes de réponse et le texte spécifiques seront probablement modifiés pendant le développement BÊTA de l’API, mais pas les plages.

Sécurité

L’API de service expose les données d’application de manière sécurisée. L’utilisation des fonctionnalités d’API est limitée aux utilisateurs authentifiés et est exposée via des protocoles de transport sécurisés. L’accès à l’API doit avoir lieu dans le contexte suivant :

Exemple d’authentification cURL

L’authentification se produit en transmettant des informations d’identification via des en-têtes HTTP sur chaque requête.
```
- username: curl -H "username:username"
- password: curl -H "password:password"
- source: curl -H "source:client_id"
```

Exemple d’authentification HTTPS

GET /api/v1/rest/
HTTPS/1.1
Host: yieldanalytics.xandr.com
Accept: application/xml, application/json
Content-Type: application/json
username: {{username}}
password: {{password}}
source: {{client_id}}

Exemple d’authentification POSTMAN

Recherchez un exemple de paramètres d’en-tête dans Postman ci-dessous :
Remarque
- 'Authorization' est défini sur « No Auth » ; Les paramètres ci-dessous doivent être placés sous l’onglet « En-têtes ».
- Pour obtenir un didacticiel plus approfondi sur l’utilisation de Postman, consultez Utilisation de Postman avec l’API Yield Analytics.

Confidentialité

La confidentialité est maintenue à l’aide de la communication basée sur la couche de sockets sécurisés pour interagir avec l’API Yield Analytics. Les développeurs d’API doivent préférer l’utilisation du protocole HTTPS à la communication http non sécurisée dans la mesure du possible. Consultez votre bibliothèque cliente HTTP pour savoir comment activer HTTP sur SSL lors du développement en dehors d’un contexte de navigateur web.

Paths

Exécuter l’analyse enregistrée

GET /api/v1/rest/queryengine/analysis/{savedAnalysisId}

Description

Rechercher une analyse enregistrée. Ces rapports peuvent être configurés dans l’interface utilisateur Yield Analytics ou via l’API Yield Analytics, puis référencés par l’ID de rapport.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
PathParameter	savedAnalysisId	savedAnalysisId	true	string
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme

application/json
Produit
- application/xml
- application/json
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100' 
-i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 
'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Exemple de requête HTTP

GET /api/v1/rest/queryengine/analysis/100 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Exécuter l’analyse enregistrée avec le nombre de lignes

GET /api/v1/rest/queryengine/analysis/{savedAnalysisId}/{rowCount}

Description

Recherchez une analyse enregistrée avec un nombre de lignes. Ces rapports peuvent être configurés dans l’interface utilisateur Yield Analytics ou via l’API Yield Analytics, puis référencés par l’ID de rapport et le résultat peut être limité au nombre de lignes souhaité.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
PathParameter	savedAnalysisId	savedAnalysisId	true	string
PathParameter	rowCount	rowCount	true	integer (int32)
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme

application/json
Produit
- application/xml
- application/json
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100/1' -i -H 'Content-Type: application/json' -H 
'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Exemple de requête HTTP

GET /api/v1/rest/queryengine/analysis/100/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Exécuter l’analyse enregistrée avec le nombre de lignes et le début de ligne

GET /api/v1/rest/queryengine/analysis/{savedAnalysisId}/{rowCount}/{startRow}

Description

Recherchez une analyse enregistrée avec un nombre de lignes et commencez la ligne. Ces rapports peuvent être configurés dans l’interface utilisateur Yield Analytics ou via l’API Yield Analytics, puis référencés par l’ID de rapport. Le nombre de lignes et les paramètres de début de ligne permettent la pagination dans les lignes du rapport.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
PathParameter	savedAnalysisId	savedAnalysisId	true	string
PathParameter	rowCount	rowCount	true	integer (int32)
PathParameter	startRow	startRow	true	integer (int32)
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme

application/json
Produit
- application/xml
- application/json
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysis/100/1/2' -i -H 'Content-Type: application/json' 
-H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Exemple de requête HTTP

GET /api/v1/rest/queryengine/analysis/100/1/2 HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Exécuter une analyse dynamique

POST /api/v1/rest/queryengine/analysisdynamic

Description

Exécutez l’analyse dynamique.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	reportDefinition	reportDefinition	true	Report
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	chaîne
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' 
-d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/analysisdynamic HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Exécuter une analyse dynamique

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}

Description

Exécutez l’analyse dynamique.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	reportDefinition	reportDefinition	true	Report
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	chaîne
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme

application/json
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/analysisdynamic HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Exécuter une analyse dynamique avec le nombre de lignes

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}/{rowCount}

Description

Exécutez l’analyse dynamique avec un nombre de lignes.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	reportDefinition	reportDefinition	true	Report
PathParameter	rowCount	rowCount	true	integer (int32)
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme

application/json
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1' -i -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/analysisdynamic/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Exécuter une analyse dynamique avec le nombre de lignes et le début de ligne

GET /api/v1/rest/queryengine/analysisdynamic/{reportDefinition}/{rowCount}/{startRow}

Description

Exécutez l’analyse dynamique avec un nombre de lignes et un début de ligne.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	reportDefinition	reportDefinition	true	Report
PathParameter	rowCount	rowCount	true	integer (int32)
PathParameter	startRow	startRow	true	integer (int32)
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme

application/json
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1/2' -i -X POST 
   -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/analysisdynamic/1/2 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Exécuter une analyse dynamique avec le nombre de lignes

POST /api/v1/rest/queryengine/analysisdynamic/{rowCount}

Description

Exécutez l’analyse dynamique avec un nombre de lignes.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	reportDefinition	reportDefinition	true	Report
PathParameter	rowCount	rowCount	true	integer (int32)
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/analysisdynamic/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Exécuter une analyse dynamique avec le nombre de lignes et le début de ligne

POST /api/v1/rest/queryengine/analysisdynamic/{rowCount}/{startRow}

Description

Exécutez l’analyse dynamique avec un nombre de lignes et un début de ligne.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	reportDefinition	reportDefinition	true	Report
PathParameter	rowCount	rowCount	true	integer (int32)
PathParameter	startRow	startRow	true	integer (int32)
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamic/1/2' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/analysisdynamic/1/2 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Obtenir un rapport d’analyseur dynamique par définition de rapport à l’aide de POST

POST /api/v1/rest/queryengine/analysisdynamicchart

Description

Les rapports définis par une définition de rapport peuvent être récupérés dynamiquement à partir de l’analyseur cible.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	reportDefinition	reportDefinition	true	Report
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	chaîne

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Obtenir un rapport d’analyseur dynamique par définition de rapport à l’aide de GET

GET /api/v1/rest/queryengine/analysisdynamicchart/{reportDefinition}

Description

Les rapports définis par une définition de rapport peuvent être récupérés dynamiquement à partir de l’analyseur cible.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	reportDefinition	reportDefinition	true	Report
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	chaîne
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK CountResponse
Consomme

application/json
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	CountResponse

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/analysisdynamicchart/' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/analysisdynamicchart/ HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 1889

{
  "report" : {
    "additionalDimensions" : [ {
      "additionalDimension" : {
        "key" : "CHANNEL"
      }
    } ],
    "additionalMetrics" : [ {
      "additionalMetric" : {
        "key" : "CHANNEL_EARNED_REVENUE_PRODUCT"
      }
    } ],
    "dimensionFilters" : [ {
      "filter" : {
        "name" : "TARGET_TYPE",
        "value" : "REPORTING",
        "operator" : "include"
      }
    } ],
    "leftYAxis" : "IMPRESSION_CAPACITY",
    "metricFilters" : [ {
      "entry" : {
        "string" : "tab1",
        "list" : {
          "filter" : [ {
            "name" : "INVENTORY_CLASS",
            "value" : "Guaranteed",
            "operator" : "include"
          } ]
        }
      }
    } ],
    "pageSize" : 25,
    "rightYAxis" : "None",
    "selectedTab" : "tab1",
    "sortBy" : "DESCENDING_LEFT_Y_AXIS",
    "stackBy" : "",
    "dashboardDateRange" : {
      "type" : "last",
      "rangeLength" : 1,
      "rangeUnits" : "months",
      "customPeriod" : false,
      "trimToRemainderOfCustomPeriod" : false
    },
    "widgetFilter" : {
      "reportParamType" : "MULTI_REPORT",
      "defaultSelections" : "PRODUCT",
      "selectionLabels" : "By Product,By Advertiser",
      "selectionValues" : "PRODUCT,ADVERTISER"
    },
    "tabDateRanges" : [ {
      "entry" : {
        "string" : "tab1",
        "dateRange" : {
          "type" : "current",
          "customPeriod" : false,
          "trimToRemainderOfCustomPeriod" : false
        }
      }
    } ],
    "tablePageSize" : 25,
    "tableState" : {
      "ascending" : false,
      "columnOrdering" : {
        "string" : [ "string" ]
      },
      "sortBy" : "IMPRESSION_CAPACITY"
    },
    "tabs" : [ {
      "tab" : {
        "displayName" : "Dataset1",
        "id" : "tab1",
        "name" : "Dataset1",
        "selected" : true
      }
    } ],
    "xAxis" : "FOCUSED_EARNED_REVENUE"
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

Requête par lots POST

POST /api/v1/rest/queryengine/batch

Description

L’appel par lot du service moteur de requête peut exécuter une séquence arbitraire d’instructions SQL et retourner un jeu de résultats. Ceux-ci peuvent être utilisés pour effectuer des opérations CRUD et/ou des sélections.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	queryStringRequest	queryStringRequest	true	QueryStringRequest
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	chaîne
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK CountResponse
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	CountResponse

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/batch' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d 
'{
  "query" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2010-07-01','2010-07-31') 
   group by consumption_date order by consumption_date asc",
  "batchQueryParams" : [ {
    "first" : "INVENTORY_CLASS",
    "second" : [ "GUARANTEED" ]
  } ]
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/batch HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 268

{
  "query" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2010-07-01','2010-07-31') 
   group by consumption_date order by consumption_date asc",
  "batchQueryParams" : [ {
    "first" : "INVENTORY_CLASS",
    "second" : [ "GUARANTEED" ]
  } ]
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 326

{
  "queryString" : "SELECT * FROM TABLE",
  "batchQueryResults" : [ {
    "batchId" : "1",
    "batchParams" : "sample batch param",
    "resultData" : {
      "row" : [ {
        "columnData" : [ {
          "name" : "sample name",
          "value" : "sample value"
        } ]
      } ]
    },
    "resultCode" : 1
  } ]
}

Requête par lots GET

GET /api/v1/rest/queryengine/batch/{queries}/{query}

Description

L’appel par lot du service moteur de requête peut exécuter une séquence arbitraire d’instructions SQL et retourner un jeu de résultats. Ceux-ci peuvent être utilisés pour effectuer des opérations CRUD et/ou des sélections.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
PathParameter	Requêtes	Requêtes	true	chaîne
BodyParameter	queryVars	queryVars	false	objet
PathParameter	requête	requête	true	string
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	chaîne
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK BatchQueryResponse
Consomme

application/json
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	BatchQueryResponse

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/batch/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')
%20group%20by%20consumption_date%20order%20by%20consumption_date%20ascconsumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20
consumption_date%20order%20by%20consumption_date%20asc' -i -H 'Content-Type: application/json;charset=UTF-8' 
-d '"{\"relativeDate\":\"2020-03-19\", \"title\":\"test\"}"'

Exemple de requête HTTP

GET /api/v1/rest/queryengine/batch/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),
'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20ascconsumptionFilter;
INVENTORY_CLASS=GUARANTEED;CONSUMPTION_TYPE=DIRECT;CONSUMPTION_TYPE=CONTAINED;PRIORITY%3E=5/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%
20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 55

"{\"relativeDate\":\"2020-03-19\", \"title\":\"test\"}"

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 326

{
  "queryString" : "SELECT * FROM TABLE",
  "batchQueryResults" : [ {
    "batchId" : "1",
    "batchParams" : "sample batch param",
    "resultData" : {
      "row" : [ {
        "columnData" : [ {
          "name" : "sample name",
          "value" : "sample value"
        } ]
      } ]
    },
    "resultCode" : 1
  } ]
}

Exécuter l’instruction à l’aide de GET

GET /api/v1/rest/queryengine/execute/{statement}

Description

Exécutez une instruction SQL transmise via l’API.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
PathParameter	instruction	instruction	true	string
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	chaîne
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	chaîne
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	chaîne

Réponses

HTTP Code Description Schéma

200 OK CountResponse
Consomme

application/json
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	CountResponse

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%
20data_source_type%20=%20'ORDER_LINE'' -i -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Exemple de requête HTTP

GET /api/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%20data_source_type%20=%20'ORDER_LINE' 
HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

Exécuter l’instruction à l’aide de POST

POST /api/v1/rest/queryengine/execute/{statement}

Description

Exécutez une instruction SQL transmise via l’API.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
PathParameter	instruction	instruction	true	chaîne
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	chaîne
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK CountResponse
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	CountResponse

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20
where%20data_source_type%20=%20'ORDER_LINE'' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/execute/select%20*%20from%20list_aliases()%20where%20data_source_type%20=%20'ORDER_LINE' 
HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

Exécuter l’instruction de requête SQL par objet de requête

POST /api/v1/rest/queryengine/executerequest

Description

Exécutez une instruction SQL en transmettant un objet Requête.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	statementHolder	statementHolder	true	QueryRequest
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK CountResponse
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	CountResponse

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/executerequest' -i 
-X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{
  "queryRequest" : {
    "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/executerequest HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 194

{
  "queryRequest" : {
    "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 118

{
  "successfulStatements" : [ "sample successful statement" ],
  "failedStatements" : [ "sample failed statement" ]
}

Instruction Query by body

POST /api/v1/rest/queryengine/query

Description

Passez une instruction SQL like dans le corps d’un billet.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	requête	requête	true	string
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query' -i -X POST 
-H 'Content-Type: application/json;charset=UTF-8' -d '{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/query HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 167

{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Interroger par instruction à l’aide de GET

GET /api/v1/rest/queryengine/query/{query}

Description

Passez une requête SQL en tant que paramètre de chemin d’accès. Pour exécuter plusieurs instructions, vos instructions doivent être délimitées par un point-virgule. Dans le cas où les données contiennent un point-virgule, utilisez la version POST de cet appel.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	requête	requête	true	string
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20
from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc' 
-i -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' 
-H 'password: {{password}}' -H 'source: {{source}}'

Exemple de requête HTTP

GET /api/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01',
'2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Interroger par instruction à l’aide de POST

POST /api/v1/rest/queryengine/query/{query}

Description

Passez une requête SQL en tant que paramètre de chemin d’accès. Pour exécuter plusieurs instructions, vos instructions doivent être délimitées par un point-virgule. Dans le cas où les données contiennent un point-virgule, utilisez la version POST de cet appel.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
PathParameter	requête	requête	true	string
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/query/select%20consumption_date,
%20sum(consumed)%20from%20OLPCS(network_products(),'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by
%20consumption_date%20asc' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' 
-H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/query/select%20consumption_date,%20sum(consumed)%20from%20OLPCS(network_products(),
'2010-07-01','2010-07-31')%20group%20by%20consumption_date%20order%20by%20consumption_date%20asc HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Requête par requête

POST /api/v1/rest/queryengine/queryrequest/{decode}

Description

Passez un objet Requête de requête pour interroger le moteur.

Paramètres

Type	Nom	Description	Obligatoire	Schéma	Par défaut
BodyParameter	requête	requête	true	QueryRequest
QueryParameter	Décoder	Décoder	false	valeur booléenne	true
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryrequest/true' -i -X POST -H 
'Content-Type: application/json;charset=UTF-8' -d '{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/queryrequest/true HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 167

{
  "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') group by 
consumption_date order by consumption_date asc"
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Jeu de requêtes à l’aide de GET

GET /api/v1/rest/queryengine/queryset

Description

L’appel du jeu de requêtes du service moteur de requête peut exécuter une séquence arbitraire d’instructions SQL et retourner un jeu de résultats. Ceux-ci peuvent être utilisés pour effectuer des opérations CRUD et/ou des sélections.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	querySet	querySet	true	QuerySet
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme

application/json
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryset' -i -H 'Content-Type: application/json;
charset=UTF-8' -d '{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}'

Exemple de requête HTTP

GET /api/v1/rest/queryengine/queryset HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 278

{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Jeu de requêtes à l’aide de POST

POST /api/v1/rest/queryengine/queryset

Description

L’appel du jeu de requêtes du service moteur de requête peut exécuter une séquence arbitraire d’instructions SQL et retourner un jeu de résultats. Ceux-ci peuvent être utilisés pour effectuer des opérations CRUD et/ou des sélections.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
BodyParameter	querySet	querySet	true	QuerySet
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryResultData
Consomme
- application/json
- application/xml
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryResultData

Exemple de demande cURL

$ curl 'https://{{client_url}}/api/v1/rest/v1/rest/queryengine/queryset' -i -X POST -H 
'Content-Type: application/json;charset=UTF-8' -d '{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}'

Exemple de requête HTTP

POST /api/v1/rest/queryengine/queryset HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: https://{{client_url}}/api/v1/rest
Content-Length: 278

{
  "querySet" : {
    "title" : "test",
    "relativeDate" : "2020-03-19",
    "requests" : [ {
      "sql" : "select consumption_date, sum(consumed) from OLPCS(network_products(),'2020-03-19','2020-06-19') 
group by consumption_date order by consumption_date asc"
    } ]
  }
}

Exemple de réponse HTTP

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 115

{
  "row" : [ {
    "columnData" : [ {
      "name" : "sample name",
      "value" : "sample value"
    } ]
  } ]
}

Les rapports définis et enregistrés dans l’analyseur cible peuvent être exécutés en tant que service REST

GET /api/v1/rest/queryengine/xml/{query}

Description

Obtenez un rapport d’analyseur enregistré par ID.

Paramètres

Type	Nom	Description	Obligatoire	Schéma
PathParameter	requête	requête qui doit être exécutée	true	string
HeaderParameter	username	Votre nom d’utilisateur pour accéder à l’API Yield Analytics	true	string
HeaderParameter	mot de passe	Votre mot de passe pour accéder à l’API Yield Analytics	true	string
HeaderParameter	source	Votre source cliente pour accéder à l’API Yield Analytics	true	string

Réponses

HTTP Code Description Schéma

200 OK QueryEngineXML
Consomme

application/json
Produit
- application/json
- application/xml
Tags

Ressource du moteur de requête

HTTP Code	Description	Schéma
200	OK	QueryEngineXML

Fonctions

Le moteur de requête prend en charge une grande quantité de fonctions de base de données génériques intégrées. Des fonctions Yield Analytics sont également en place pour faciliter l’utilisation du modèle d’inventaire.

Fonction	Description	Exemple
ACTIVE_RATE_CARD_PRODUCTS	retourne tous les ID de produit (PID) de taux carte actifs dans le système	EXEMPLE DE TEST
ACTIVE_REPORTING_PRODUCTS	retourne tous les ID de produits de création de rapports (PID) actifs dans le système	EXEMPLE DE TEST
ALL_RATE_CARD_PRODUCTS	retourne tous les TAUX carte ID de produits (PID) dans le système	EXEMPLE DE TEST
ALL_RATE_CARD_PRODUCTS	retourne tous les ID de produits de création de rapports (PID) dans le système	EXEMPLE DE TEST
PRODUCT_GROUP	groupNames retourne tous les ID de produit dans le groupe cible avec le nom donné	EXEMPLE DE TEST
PRODUCTS_BY_CHARACTERISTICS	caractéristiques - par exemple, taille=120x90, taille=460x80, sexe=homme, comportement !=politique retourner tous les ID de produit correspondant aux caractéristiques données	EXEMPLE DE TEST
PRODUCTS_BY_MATCHPRASE	correspondances	EXEMPLE DE TEST
PRODUCTS_BY_NAME	noms	EXEMPLE DE TEST

Alias

ALIAS_KEY	DATASOURCE_TYPE
ACTIONS	< >ACTION_NAME_TOTAL_ACTIONS_POST_IMPRESSIONS
ACTIONS	< >ACTION_NAME_TOTAL_ACTIONS
ACTIONS	< >ACTION_NAME_ECPA
ANNONCEUR	ORDER_LINE
AGENCE	ORDER_LINE
DISPONIBILITÉ	PRODUIT
AVERAGE_FREQUENCY_DAILY	PRODUIT
AVERAGE_FREQUENCY_WEEKLY	PRODUIT
AVERAGE_UNIQUES_DAILY	PRODUIT
AVERAGE_UNIQUES_WEEKLY	PRODUIT
BOOKED_CPM	ORDER_LINE
BOOKED_IMPRESSIONS	ORDER_LINE
BOOKED_VALUE	ORDER_LINE
BOOKING_TYPE	OLP_IMPRESSIONS
CAMPAIGN_NAME	ORDER_LINE
CLOSE_DATE	ORDER_LINE
CONSUMED_IMPRESSIONS	OLP_IMPRESSIONS
CONSUMED_IMPRESSIONS_LIFETIME	OLP_IMPRESSIONS
CONSUMED_VALUE	ORDER_LINE
CONSUMPTION_DATE	OLP_IMPRESSIONS
CONSUMPTION_TYPE	OLP_IMPRESSIONS
CONTRACT_TYPE	ORDER_LINE
CONTRACTED_CPD	ORDER_LINE
CONTRACTED_CPD_OLTP	OLTP
CONTRACTED_CPM	ORDER_LINE
CONTRACTED_IMPRESSIONS	ORDER_LINE
CONTRACTED_IMPRESSIONS_CPM_ONLY	ORDER_LINE
CONTRACTED_IMPRESSIONS_CPM_ONLY_OLTP	OLTP
CONTRACTED_IMPRESSIONS_GOAL_BASED_ONLY	ORDER_LINE
CONTRACTED_IMPRESSIONS_LIFETIME	ORDER_LINE
CONTRACTED_IMPRESSIONS_OLTP	OLTP
CONTRACTED_IMPRESSIONS_TOTAL	ORDER_LINE
CONTRACTED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE	ORDER_LINE
CONTRACTED_RATE	ORDER_LINE
CONTRACTED_REVENUE	ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY	ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY_FULL	ORDER_LINE
CONTRACTED_REVENUE_CPD_ONLY_OLTP	OLTP
CONTRACTED_REVENUE_CPM_ONLY	ORDER_LINE
CONTRACTED_REVENUE_CPM_ONLY_FULL	ORDER_LINE
CONTRACTED_REVENUE_CPM_ONLY_OLTP	OLTP
CONTRACTED_REVENUE_FULL	ORDER_LINE
CONTRACTED_REVENUE_LIFETIME	ORDER_LINE
CONTRACTED_REVENUE_OLTP	OLTP
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE	ORDER_LINE
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE_FULL	ORDER_LINE
CONTRACTED_REVENUE_SALES_DISCOUNT_CALCULABLE_OLTP	OLTP
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE	ORDER_LINE
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP	OLTP
CONTRACTED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
CURRENT_PRODUCT_ID	ORDER_LINE
DATA_ELEMENTS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
DAYS_IN_CPD_ONLY	ORDER_LINE
DAYS_IN_CPD_ONLY_OLTP	OLTP
DAYS_TO_DELIVERY	OLP_IMPRESSIONS
DAYS_TO_DELIVERY_CUM	OLP_IMPRESSIONS
DELIVERABLE_GUARANTEED_IMPRESSIONS	ORDER_LINE
DELIVERABLE_IMPRESSIONS	ORDER_LINE
DELIVERABLE_IMPRESSIONS_LIFETIME	ORDER_LINE
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE	OLP_IMPRESSIONS
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP	OLTP
DELIVERABLE_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
DELIVERED_CLICKS	OLP_CLICKS
DELIVERED_CLICKS_LIFETIME	OLP_CLICKS
DIRECT_AVERAGE_FREQUENCY_DAILY	ORDER_LINE
DIRECT_AVERAGE_FREQUENCY_WEEKLY	ORDER_LINE
DIRECT_AVERAGE_UNIQUES_DAILY	ORDER_LINE
DIRECT_AVERAGE_UNIQUES_WEEKLY	ORDER_LINE
DIRECT_LIFETIME_UNIQUES	ORDER_LINE
EARNED_IMPRESSIONS	ORDER_LINE
EARNED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE	ORDER_LINE
EARNED_REVENUE	ORDER_LINE
EARNED_REVENUE_LIFETIME	ORDER_LINE
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE	ORDER_LINE
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP	OLTP
EARNED_REVENUE_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
END_DATE	ORDER_LINE
ESTABLISHED_ASP	PRODUIT
EXTERNAL_ID	ORDER_LINE
ÉTAGE	PRODUIT
FOCUSED_CONSUMED_VALUE	OLP_IMPRESSIONS
FOCUSED_EARNED_IMPRESSIONS	OLP_IMPRESSIONS
FOCUSED_EARNED_REVENUE	OLPEVENT
HARD_CUTOFF	ORDER_LINE
IMPRESSION_CAP_PER_DAY	ORDER_LINE
IMPRESSION_CAPACITY	PRODUIT
IN_NETWORK	ORDER_LINE
INDUSTRIE	ORDER_LINE
INVENTORY_CLASS	ORDER_LINE
MASTER_ID	ORDER_LINE
MC_TYPE	ORDER_LINE
NETWORK_STATUS	PRODUIT
COMMANDE	ORDER_LINE
ORDER_EXTERNAL_ID	ORDER_LINE
ORDER_LINE	ORDER_LINE
ORDER_LINE_DELIVERY_SCOPE_TARGET	ORDER_LINE
ORDER_LINE_ID	ORDER_LINE
ORDER_LINE_SITE_NAME	ORDER_LINE
ORDER_LINE_SIZE	ORDER_LINE
ORDER_LINE_STATUS	ORDER_LINE
ORDER_LINE_TARGET	ORDER_LINE
ORDER_LINE_TARGET_ATTRIBUTE	ORDER_LINE
ORDER_LINE_TARGET_EXPRESSION	ORDER_LINE
ORDER_LINE_TARGET_EXTERNAL_ID	ORDER_LINE
ORDER_LINE_TARGET_ID	ORDER_LINE
ORDER_NAME	ORDER_LINE
ORDER_STATE	ORDER_LINE
PACKAGE_ID	ORDER_LINE
PARENT_TARGET	PRODUIT
PRICING_TYPE	ORDER_LINE
PRIORITÉ	ORDER_LINE
PRODUIT	PRODUIT
PRODUIT	RATE_CARD
PRODUIT	REPORTING_TYPE
PRODUIT	REVENUE_CAPACITY
PRODUIT	SELL_STATUS
PRODUIT	STATUT
PRODUIT	TARGET_ATTRIBUTE
PRODUIT	TARGET_CREATION_DATE
PRODUIT	TARGET_GROUP
PRODUIT	TARGET_ID
PRODUIT	TARGET_OVERLAP
PRODUIT	TARGET_TYPE
PRODUIT	UNMET_DEMAND
PRODUIT	WEIGHTED_RATE_CARD
PRODUIT	< >ACTION_NAME_TOTAL_ACTIONS_POST_CLICKS
PRODUCT_EXPRESSION PRODUCT	PRODUCT_EXTERNAL_ID
RANGE_END	ORDER_LINE
RANGE_START	ORDER_LINE
RATE_CARD_REVENUE	ORDER_LINE
RATE_CARD_REVENUE_CPM_ONLY	ORDER_LINE
RATE_CARD_REVENUE_CPM_ONLY_OLTP	OLTP
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE	ORDER_LINE
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE_FULL	OLTP
RATE_CARD_REVENUE_SALES_DISCOUNT_CALCULABLE_OLTP	OLTP
SALES_PERSON	ORDER_LINE
SALES_TEAM_MEMBER	ORDER_LINE
SCHEDULED_IMPRESSIONS	ORDER_LINE
SCHEDULED_IMPRESSIONS_LIFETIME	ORDER_LINE
SCHEDULED_IMPRESSIONS_OLTP	OLTP
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE	OLP_IMPRESSIONS
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP	OLTP
SCHEDULED_IMPRESSIONS_UNDERDELIVERY_CALCULABLE_OLTP_LIFETIME	OLTP
SOLD_AS_PRODUCT	ORDER_LINE
SOLD_AS_PRODUCT_ID	ORDER_LINE
START_DATE	ORDER_LINE
SYSTEM_OF_RECORD	ORDER_LINE
TILE_IDS	ORDER_LINE
TILE_NAMES	ORDER_LINE

Définitions

AdditionalDimension

Objet JSON pour contenir les résultats de AdditionalDimension du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
groupingModifier	Modificateur de regroupement d’une dimension supplémentaire	true	string
clé	Clé d’une dimension supplémentaire	true	string

AdditionalMetric

Objet JSON pour contenir les résultats de AdditionalMetric of Analyzer Report.

Nom	Description	Obligatoire	Schéma
clé	Clé d’une dimension supplémentaire	true	string

AnalyzerReport

Objet JSON pour contenir les résultats d’AnalyzerReport.

Nom	Description	Obligatoire	Schéma
additionalDimensions	Collection de dimensions supplémentaires	false	Tableau MapOfstringAndAdditionalDimension
additionalMetrics	Collection de métriques supplémentaires	false	Tableau MapOfstringAndAdditionalMetric
dashboardDateRange	La rage de date du tableau de bord du rapport de l’analyseur	false	DateRangeData
dashboardDimension	Dimension du tableau de bord du rapport de l’analyseur	false	chaîne
tableau de bordTableData	Données de table de tableau de bord du rapport de l’analyseur	false	TableState
dateRange	Plage de dates du rapport de l’analyseur	false	DateRangeData
dateRangeFilters	Collection de filtres de plage de dates de rapport	false	Tableau MapOfstringAndReportDateRangeFilter
dimensionFilters	Collection de filtres de dimension	false	Tableau MapOfstringAndFilter
includeZeroValues	Le champ Inclure des valeurs zéro du rapport de l’analyseur	false	string
keyValueFilters	Collection de filtres de valeurs de clé de rapport	false	Tableau MapOfstringAndReportKeyValueFilter
leftYAxis	Axe Y gauche du rapport de l’analyseur	true	chaîne
metricFilters	Mappage du nom à une liste de filtres de métriques	true	Tableau MapOfstringAndMetricFilterEntry
numericRangeFilters	Le champ contient une liste de filtres de plages numériques	false	Tableau MapOfstringAndReportNumericRangeFilter
Orderby	Ordre par champ du rapport de l’analyseur	false	string
Pagesize	Taille de page du rapport de l’analyseur	false	integer (int32)
rightYAxis	Axe Y droit du rapport de l’analyseur	false	string
selectedTab	Onglet sélectionné du rapport de l’analyseur	false	string
sizeBy	Taille par champ du rapport de l’analyseur	false	string
sortBy	Tri par champ du rapport de l’analyseur	false	string
stackBy	Pile par champ du rapport de l’analyseur	false	string
stackbyIncrement	Champ pile par incrément du rapport de l’analyseur	false	chaîne
tabDateRanges	Mappage du nom aux plages de dates de table	true	Tableau MapOfstringAndDateRangeEntry
tablePageSize	Taille de la page de table du rapport de l’analyseur	false	integer (int32)
tableState	État de la table du rapport de l’analyseur	false	TableState
onglets	Le champ contient une liste d’onglets	true	Tableau MapOfstringAndTab
trendPoints	Collection de points de tendance	false	Tableau MapOfstringAndTrendPoint
view	Vue du rapport de l’analyseur	false	chaîne
widgetCacheWarm	Champ chaud du cache du widget du rapport de l’analyseur	false	string
widgetFilter	Filtre de widget du rapport de l’analyseur	false	WidgetFilter
widgetNumericType	Type numérique de widget du rapport de l’analyseur	false	enum (NEGATIVE_ONLY, POSITIVE_ONLY)
widgetView	Vue widget du rapport de l’analyseur	false	chaîne
xAxis	Axe x du rapport de l’analyseur	true	string
xAxisIncrement	Incrément de l’axe x du rapport de l’analyseur	false	chaîne

BatchQueryParams

Objet JSON pour contenir les paramètres de requête par lots.

Nom	Description	Obligatoire	Schéma
Première	Premier champ des paramètres de requête par lots	true	string
Deuxième	Collection de deuxièmes champs	true	tableau de chaînes

BatchQueryResponse

Objet JSON pour contenir les résultats d’une réponse de requête par lots.

Nom	Description	Obligatoire	Schéma
batchQueryResults	Collection de résultats de requête par lots	false	Tableau BatchQueryResult
Querystring	Chaîne de requête de la réponse de requête par lot	true	string

BatchQueryResult

Objet JSON pour contenir les résultats d’une requête par lots.

Nom	Description	Obligatoire	Schéma
batchId	ID de lot du résultat de la requête par lots	true	string
batchParams	Paramètres de lot du résultat de la requête batch	true	string
resultCode	Code de résultat du résultat de la requête par lots	true	integer (int32)
resultData	Données de résultat de requête du résultat de la requête par lots	true	QueryResultData

Column

Nom	Description	Obligatoire	Schéma
nom	Nom de l’en-tête	false	string
valeur	Valeur de l’en-tête	false	string

ColumnData

Objet JSON pour contenir les résultats d’une colonne de données.

Nom	Description	Obligatoire	Schéma
nom	Nom des données de colonne	true	string
valeur	Objet valeur des données de colonne	true	chaîne

ColumnFilter

Objet JSON pour contenir les résultats de ColumnFilter du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
champ	Champ du filtre de colonne	true	chaîne
Logique	Logique du filtre de colonne	true	string
opérateur	Collection d’opérateurs	true	tableau de chaînes
valeur	Collection de valeurs	true	tableau de chaînes

ColumnSort

Objet JSON pour contenir les résultats de ColumnSort of Analyzer Report.

Nom	Description	Obligatoire	Schéma
direction	Direction du tri des colonnes	true	string
champ	Champ du tri de colonne	true	string

CountResponse

Objet JSON pour contenir les résultats d’une réponse de comptage.

Nom	Description	Obligatoire	Schéma
failedStatements	Nombre d’instructions ayant échoué	false	tableau de chaînes
successfulStatements	Nombre d’instructions réussies	false	tableau de chaînes

DateRangeData

Objet JSON pour contenir les résultats de DateRangeData of Analyzer Report.

Nom	Description	Obligatoire	Schéma
customCalendarId	ID de calendrier personnalisé des données de plage de dates	false	string
customPeriod	Champ de période personnalisé des données de plage de dates	false	valeur booléenne
endDate	Date de fin des données de plage de dates	false	string
rangeLength	Longueur de plage des données de plage de dates	false	integer (int32)
rangeUnits	Unités de plage des données de plage de dates	false	string
startDate	Date de début des données de plage de dates	false	string
trimToRemainderOfCustomPeriod	Découpage vers le reste du champ de période personnalisée des données de plage de dates	false	valeur booléenne
type	Type des données de plage de dates	true	chaîne

DateRangeEntry

Objet JSON pour contenir DateRangeEntry.

Nom	Description	Obligatoire	Schéma
dateRange	Champ dateRange de l’objet DateRangeEntry	false	DateRangeData
chaîne	Champ de chaîne de dateRangeEntry	true	string

Filtre

Objet JSON pour contenir les résultats du filtre du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
nom	Nom du filtre	true	string
opérateur	Opérateur du filtre	true	string
valeur	Valeur du filtre	true	chaîne

Objet JSON pour contenir les résultats du filtre du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
Generated	Chaîne d’en-tête générée	false	string
requête	Chaîne de requête de l’en-tête	false	chaîne

MetricFilterEntry

Objet JSON pour contenir MetricFilterEntry.

Nom	Description	Obligatoire	Schéma
liste	Collection de filtres	false	objet
chaîne	Champ de chaîne de MetricFilterEntry	true	string

QueryEngineXML

Objet JSON pour contenir le résultat de la requête.

Nom	Description	Obligatoire	Schéma
en-tête	En-tête du code xml du moteur de requête	true	Header
Resultset	Jeu de résultats du code xml du moteur de requête	true	Resultset

QueryRequest

Objet JSON pour contenir le résultat de la requête.

Nom	Description	Obligatoire	Schéma
queryRequest		false	QueryRequest
Sql	Entrée SQL dans le moteur de requête	true	string

QueryResultData

Objet JSON pour contenir les résultats d’une requête.

Nom	Description	Obligatoire	Schéma
row	Collection de données de ligne	false	Tableau RowData

RowData

Objet JSON pour contenir les résultats des données d’une ligne.

Nom	Description	Obligatoire	Schéma
columnData	Collection de données de colonne	true	Tableau ColumnData

QuerySet

Objet JSON pour contenir les résultats d’une requête.

Nom	Description	Obligatoire	Schéma
querySet		false	QuerySet
relativeDate	Données relatives du jeu de requêtes	true	string
Requêtes	Collection de requêtes	false	QueryRequest , tableau
title	Titre de l’ensemble de requêtes	true	chaîne

QueryStringRequest

Objet JSON pour contenir la requête de chaîne de requête.

Nom	Description	Obligatoire	Schéma
batchQueryParams	Collection de paramètres de requête par lots	true	Tableau BatchQueryParams
requête	Champ de requête de la demande de chaîne de requête	true	string

Rapport

Objet JSON pour contenir la requête de chaîne de requête.

Nom	Description	Obligatoire	Schéma
Rapport		false	AnalyzerReport

ReportDateRangeFilter

Objet JSON pour contenir les résultats de ReportDateRangeFilter d’Analyzer Report.

Nom	Description	Obligatoire	Schéma
dataSetKey	Clé de jeu de données du filtre de plage de dates du rapport	true	string
dateRange	Données de plage de dates du filtre de plage de dates du rapport	true	DateRangeData
clé	Clé du filtre de plage de dates du rapport	true	string

ReportKeyValueFilter

Objet JSON pour contenir les résultats de ReportKeyValueFilter du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
dataSetKey	Clé de jeu de données du filtre de valeur de clé de rapport	true	string
clé	Clé du filtre de valeur de clé de rapport	true	chaîne
nom	Nom du filtre de valeurs de clé de rapport	true	string
opérateur	Opérateur du filtre de valeur de clé de rapport	true	string
valeur	Valeur du filtre de valeur de clé de rapport	true	string
valueMatchTypeValue	Valeur de type de correspondance de valeur du filtre de valeur de clé de rapport	true	chaîne

ReportNumericRangeFilter

Objet JSON pour contenir les résultats de ReportNumericRangeFilter du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
dataSetKey	Clé de jeu de données du filtre de plage numérique de rapport	true	chaîne
highValue	Valeur élevée du filtre de plage numérique de rapport	true	nombre (double)
id	ID du filtre de plage numérique de rapport	true	integer (int32)
clé	Clé du filtre de plage numérique de rapport	true	chaîne
lowValue	Valeur faible du filtre de plage numérique de rapport	true	nombre (double)

Resultset

Objet JSON pour contenir les résultats de ReportNumericRangeFilter du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
Objet Rows	Collection de lignes	false	Tableau de lignes

Ligne

Nom	Description	Obligatoire	Schéma
colonnes	Collection de colonnes	false	Tableau de colonnes

Column

Nom	Description	Obligatoire	Schéma
nom	Nom de l’en-tête	false	chaîne
valeur	Valeur de l’en-tête	false	chaîne

RowData

Objet JSON pour contenir les résultats des données d’une ligne.

Nom	Description	Obligatoire	Schéma
columnData	Collection de données de colonne	true	Tableau ColumnData

Tab

Objet JSON pour contenir les résultats de l’onglet du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
displayName	Nom complet de l’onglet	true	string
id	ID de l’onglet	true	chaîne
nom	Nom de l’onglet	true	chaîne
Sélectionné	Champ sélectionné de l’onglet	true	valeur booléenne

TableState

Objet JSON pour contenir les résultats de TableState du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
ascending	Champ croissant de l’état de la table	true	valeur booléenne
columnFilters	Collection de filtres de colonnes	false	Tableau ColumnFilter
columnOrdering	Collection de classement des colonnes	true	objet
columnSorts	Collection de tris de colonnes	false	Tableau ColumnSort
clé	Clé de l’état de la table	false	string
sortBy	Tri par champ de l’état de la table	true	string

TrendPoint

Objet JSON pour contenir les résultats de TrendPoint of Analyzer Report.

Nom	Description	Obligatoire	Schéma
clé	La clé du point de tendance	true	chaîne

Objet JSON pour contenir les résultats de WidgetFilter du rapport d’analyseur.

Nom	Description	Obligatoire	Schéma
defaultSelections	Sélections par défaut du filtre de widget	true	chaîne
reportParamType	Type de paramètre de rapport du filtre de widget	true	string
selectionLabels	Étiquettes de sélection du filtre de widget	true	chaîne
selectionValues	Valeurs de sélection du filtre de widget	true	string

Yield Analytics API

Last updated on 2025-04-02

Partager via

Service moteur de requête

Vue d’ensemble

Types de contenu

Vérification des erreurs et codes status

Sécurité

Confidentialité

Paths

Exécuter l’analyse enregistrée

Exécuter l’analyse enregistrée avec le nombre de lignes

Exécuter l’analyse enregistrée avec le nombre de lignes et le début de ligne

Exécuter une analyse dynamique

Exécuter une analyse dynamique

Exécuter une analyse dynamique avec le nombre de lignes

Exécuter une analyse dynamique avec le nombre de lignes et le début de ligne

Exécuter une analyse dynamique avec le nombre de lignes

Exécuter une analyse dynamique avec le nombre de lignes et le début de ligne

Obtenir un rapport d’analyseur dynamique par définition de rapport à l’aide de POST

Obtenir un rapport d’analyseur dynamique par définition de rapport à l’aide de GET

Requête par lots POST

Requête par lots GET

Exécuter l’instruction à l’aide de GET

Exécuter l’instruction à l’aide de POST

Exécuter l’instruction de requête SQL par objet de requête

Instruction Query by body

Interroger par instruction à l’aide de GET

Interroger par instruction à l’aide de POST

Requête par requête

Jeu de requêtes à l’aide de GET

Jeu de requêtes à l’aide de POST

Les rapports définis et enregistrés dans l’analyseur cible peuvent être exécutés en tant que service REST

Fonctions

Alias

Définitions

AdditionalDimension

AdditionalMetric

AnalyzerReport

BatchQueryParams

BatchQueryResponse

BatchQueryResult

Column

ColumnData

ColumnFilter

ColumnSort

CountResponse

DateRangeData

DateRangeEntry

Filtre

En-tête

MetricFilterEntry

QueryEngineXML

QueryRequest

QueryResultData

RowData

QuerySet

QueryStringRequest

Rapport

ReportDateRangeFilter

ReportKeyValueFilter

ReportNumericRangeFilter

Resultset

Ligne

Column

RowData

Tab

TableState

TrendPoint

WidgetFilter

Rubrique connexe

Ressources supplémentaires