Périodes

 

Avant-propos

Voir l’exemple Postman

L’objet p1 est obligatoire, il s’agit de la période principale d’analyse.

L’objet p2 est facultatif, il décrit la période de comparaison.

ParamètreDescriptionValeurs possibles
typeR(elative) ou Absolute: D(ay), M(onth)
 

Périodes absolues

Format de la date : yyyy-mm-dd

 

// Périodes absolues :
"period": {
  "p1": [
    {
      "type": "D",
      "start": "2019-10-20",
      "end": "2019-10-24"
    }
  ],
  "p2": [
    {
      "type": "D",
      "start": "2019-10-15",
      "end": "2019-10-19"
    }
  ]
}

# Périodes absolues :
"period": {
  "p1": [
    {
      "type": "D",
      "start": "2019-10-20",
      "end": "2019-10-24"
    }
  ],
  "p2": [
    {
      "type": "D",
      "start": "2019-10-15",
      "end": "2019-10-19"
    }
  ]
}

# Périodes absolues :
"period": {
  "p1": [
    {
      "type": "D",
      "start": "2019-10-20",
      "end": "2019-10-24"
    }
  ],
  "p2": [
    {
      "type": "D",
      "start": "2019-10-15",
      "end": "2019-10-19"
    }
  ]
}

# Périodes absolues :
"period": {
  "p1": [
    {
      "type": "D",
      "start": "2019-10-20",
      "end": "2019-10-24"
    }
  ],
  "p2": [
    {
      "type": "D",
      "start": "2019-10-15",
      "end": "2019-10-19"
    }
  ]
}

 

 

Périodes relatives

Dans le cas d’un appel sur un seul site, la période relative sera en fonction du fuseau horaire du site. Dans le cas d’un appel multi-sites, la période relative sera en relation avec le fuseau horaire le plus à l’est des sites demandés.

Si vous appelez un site A (UTC-1) et un site B (UTC+2), alors la période relative sera relative au site B.

ParamètreDescriptionValeurs possibles
granularityY(ear), Q(uarter), M(onth), W(eek), D(ay)
offSetNombre

// Périodes relatives :

"period": {
    "p1": [
      {
        "type": "R",
        "granularity": "D",
        "offset": -1
      }
    ],
    "p2": [
      {
        "type": "R",
        "granularity": "D",
        "offset": -2
      }
    ]
  }

# Périodes relatives :

"period": {
    "p1": [
      {
        "type": "R",
        "granularity": "D",
        "offset": -1
      }
    ],
    "p2": [
      {
        "type": "R",
        "granularity": "D",
        "offset": -2
      }
    ]
  }

# Périodes relatives :

"period": {
    "p1": [
      {
        "type": "R",
        "granularity": "D",
        "offset": -1
      }
    ],
    "p2": [
      {
        "type": "R",
        "granularity": "D",
        "offset": -2
      }
    ]
  }

# Périodes relatives :

"period": {
    "p1": [
      {
        "type": "R",
        "granularity": "D",
        "offset": -1
      }
    ],
    "p2": [
      {
        "type": "R",
        "granularity": "D",
        "offset": -2
      }
    ]
  }

 

Dernière mise à jour : 04/05/2021