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
typeR (Relatif), AP (Relatif à la période d’analyse)
granularityY(ear), Q(uarter), M(onth), W(eek), D(ay)
startOffsetNombre
endOffsetNombre
 

Les périodes relatives par rapport à la date d’analyse sont appliquées que sur les segments visiteurs/utilisateurs.

Les périodes de type AP s’adapteront à la date d’analyse, prenons comme exemple l’appel suivant qui a :

  • Une période d’analyse de type R qui nous donnera une date par rapport à la date du jour qui sera pour l’exemple suivant 01-04-2021 nous aurons comme résultat pour la première période la date du mois précedent qui est du 01-03-2021 jusqu’au 31-03-2021.
  • Une autre date de type AP pour le segment qui s’adaptera à la date d’analyse qui représente pour notre exemple le mois de mars donc pour la période du segment nous aurons comme résultat la date du 01-02-2021 jusqu’au 28-02-2021.
 

// Querying relative periods:
"period": {
        "p1": [
            {
                "type": "R",
                "granularity": "M",
                "startOffset": -1,    
                "endOffset": -1
            }
        ]
    },
    "space": {
        "s": [
            608209
        ]
    },
    "columns": [
        "visit_src",
        "m_visits"
    ],
    "page-num": 1,
    "max-results": 10,
    "sort": [
        "-m_visits"
    ],
    "segment": {
        "section": {
            "mode": "include",
            "scope": "visitor_id",
            "period": {
                "p1": [
                    {
                        "type": "AP",
                        "granularity": "M",
                        "startOffset": -1,
                        "endOffset": -1
                    }
                ]
            },
            "content": {
                "condition": {
                    "filter": {
                        "visit_geo_country": {
                            "$eq": "France"
                        }
                    }
                }
            }
        }
    }

# Querying relativeperiods:
"period": {
        "p1": [
            {
                "type": "R",
                "granularity": "M",
                "startOffset": -1,    
                "endOffset": -1
            }
        ]
    },
    "space": {
        "s": [
            608209
        ]
    },
    "columns": [
        "visit_src",
        "m_visits"
    ],
    "page-num": 1,
    "max-results": 10,
    "sort": [
        "-m_visits"
    ],
    "segment": {
        "section": {
            "mode": "include",
            "scope": "visitor_id",
            "period": {
                "p1": [
                    {
                        "type": "AP",
                        "granularity": "M",
                        "startOffset": -1,
                        "endOffset": -1
                    }
                ]
            },
            "content": {
                "condition": {
                    "filter": {
                        "visit_geo_country": {
                            "$eq": "France"
                        }
                    }
                }
            }
        }
    }

# Querying relativeperiods:
"period": {
        "p1": [
            {
                "type": "R",
                "granularity": "M",
                "startOffset": -1,    
                "endOffset": -1
            }
        ]
    },
    "space": {
        "s": [
            608209
        ]
    },
    "columns": [
        "visit_src",
        "m_visits"
    ],
    "page-num": 1,
    "max-results": 10,
    "sort": [
        "-m_visits"
    ],
    "segment": {
        "section": {
            "mode": "include",
            "scope": "visitor_id",
            "period": {
                "p1": [
                    {
                        "type": "AP",
                        "granularity": "M",
                        "startOffset": -1,
                        "endOffset": -1
                    }
                ]
            },
            "content": {
                "condition": {
                    "filter": {
                        "visit_geo_country": {
                            "$eq": "France"
                        }
                    }
                }
            }
        }
    }

# Querying relativeperiods:
"period": {
        "p1": [
            {
                "type": "R",
                "granularity": "M",
                "startOffset": -1,    
                "endOffset": -1
            }
        ]
    },
    "space": {
        "s": [
            608209
        ]
    },
    "columns": [
        "visit_src",
        "m_visits"
    ],
    "page-num": 1,
    "max-results": 10,
    "sort": [
        "-m_visits"
    ],
    "segment": {
        "section": {
            "mode": "include",
            "scope": "visitor_id",
            "period": {
                "p1": [
                    {
                        "type": "AP",
                        "granularity": "M",
                        "startOffset": -1,
                        "endOffset": -1
                    }
                ]
            },
            "content": {
                "condition": {
                    "filter": {
                        "visit_geo_country": {
                            "$eq": "France"
                        }
                    }
                }
            }
        }
    }

 

Dernière mise à jour : 21/07/2021