Diagnostics
Issues found by the calculation engine, for example a survey wave of a trend that was discarded, or a user variable or target that could not be resolved in a wave of a trend. The table is still returned (200), calculated without them. Present only when there is at least one diagnostic. In a table that is not a trend, a user variable or target that does not exist is a 400 error, not a diagnostic.
Overall severity of the diagnostics: the worst level among the one of the calculation and the level of each item of diagnostics, so it is never lower than the level of any of them. Each diagnostic keeps its own level; decide what to do from its code.
| Enum Value | Description |
|---|---|
| NONE | Nothing to report. |
| INFO | Informative message only. |
| WARNING | Some items could not be resolved; the rest is calculated. |
| ERROR | An error found during the calculation; the table is still returned. |
Possible values: [NONE, INFO, WARNING, ERROR]
diagnostics object[]
The diagnostics of this calculation, one per issue found.
Code of the diagnostic. Base your handling on it, not on the message.
Severity of this diagnostic.
| Enum Value | Description |
|---|---|
| NONE | Nothing to report. |
| INFO | Informative message only. |
| WARNING | Some items could not be resolved; the rest is calculated. |
| ERROR | An error found during the calculation; the table is still returned. |
Possible values: [NONE, INFO, WARNING, ERROR]
Type of table the message refers to. It gives meaning to the keys of message. Omitted when the table is of a kind this version of the API does not describe.
| Enum Value | Description |
|---|---|
| TABULATION | Cross-tabulation of survey variables. |
| TREND | Evolution of the figures across survey waves. |
| BREAKDOWN_CARRIERS | Audience breakdown by carrier. |
| DUPLICATIONS | Duplication between carriers. |
| REACH_TABLE | Reach and time statistics of the carriers of a diary survey. |
| REACH_DUPLICATION | Audience overlap between the carriers of a diary survey. |
| REACH_TREND | Reach and time statistics compared across survey waves. |
| RANKING | Ranking of carriers. |
| EVALUATION | Evaluation of a media plan. |
Possible values: [TABULATION, TREND, BREAKDOWN_CARRIERS, DUPLICATIONS, REACH_TABLE, REACH_DUPLICATION, REACH_TREND, RANKING, EVALUATION]
message object
Details of the diagnostic. Its keys depend on messageType; for example title, type, dimension, axis, status, source and sourceIndex. The values are localized: do not parse them.
Details of the diagnostic. Its keys depend on messageType; for example title, type, dimension, axis, status, source and sourceIndex. The values are localized: do not parse them.
{
"level": "NONE",
"diagnostics": [
{
"code": "string",
"level": "NONE",
"messageType": "TABULATION",
"message": {}
}
]
}