# Datanumia Developer Portal

- [Welcome](https://docs.datanumia.com/index.md): The Datanumia Developer Portal is the way to get started with the Datanumia platform. It gives you a way to understand the platform, configure your integration, secure your requests, and choose your delivery model.
- [What is Home ?](https://docs.datanumia.com/docs/DatanumiaHome/01-introduction/01-what-is-home.md)
- [APIs and Webcomponents](https://docs.datanumia.com/docs/DatanumiaHome/01-introduction/02-APIs-and-webcomponents.md)
- [Core Concepts](https://docs.datanumia.com/docs/DatanumiaHome/01-introduction/03-core-concepts.md)
- [Offers prices](https://docs.datanumia.com/docs/DatanumiaHome/03-offer-catalog/02-offers-prices.md)
- [Add, modify and delete users](https://docs.datanumia.com/docs/DatanumiaHome/04-manage-your-users/01-add-modify-and-delete-users.md)
- [Contracts](https://docs.datanumia.com/docs/DatanumiaHome/04-manage-your-users/02-provide-end-user-data/01-contracts.md)
- [Consumption data](https://docs.datanumia.com/docs/DatanumiaHome/04-manage-your-users/02-provide-end-user-data/02-consumption-data.md)
- [Profiles](https://docs.datanumia.com/docs/DatanumiaHome/04-manage-your-users/02-provide-end-user-data/03-profils.md)
- [Profile initialization and update](https://docs.datanumia.com/docs/DatanumiaHome/05-home-basic/01-profil-init-and-update.md)
- [Consumption calculation](https://docs.datanumia.com/docs/DatanumiaHome/05-home-basic/02-consumption-calculation.md)
- [Consumption disaggregation](https://docs.datanumia.com/docs/DatanumiaHome/05-home-basic/03-consumption-disaggregation.md)
- [Consumption comparisons](https://docs.datanumia.com/docs/DatanumiaHome/05-home-basic/04-consumption-comparisons.md)
- [Consumption prediction](https://docs.datanumia.com/docs/DatanumiaHome/06-home-coaching/01-consumption-prediction.md)
- [Targets](https://docs.datanumia.com/docs/DatanumiaHome/06-home-coaching/02-targets.md)
- [General presentation](https://docs.datanumia.com/docs/DatanumiaHome/07-home-energy-management/01-general-presentation.md)
- [Introduction](https://docs.datanumia.com/docs/DatanumiaHome/07-home-energy-management/02-control-scenarios/01-introduction.md)
- [Heating control scenarios](https://docs.datanumia.com/docs/DatanumiaHome/07-home-energy-management/02-control-scenarios/02-heating-control-scenarios.md)
- [Smart charging](https://docs.datanumia.com/docs/DatanumiaHome/07-home-energy-management/02-control-scenarios/03-smart-charging.md)
- [What are webcomponents ?](https://docs.datanumia.com/docs/DatanumiaHome/08-home-interfaces/01-what-are-webcomponents.md)
- [Consumption calculation](https://docs.datanumia.com/docs/DatanumiaHome/08-home-interfaces/02-home-basic-interfaces/01-consumption-calculation.md)
- [Consumption disaggregation](https://docs.datanumia.com/docs/DatanumiaHome/08-home-interfaces/02-home-basic-interfaces/02-consumption-disaggregation.md)
- [Profile completion](https://docs.datanumia.com/docs/DatanumiaHome/08-home-interfaces/02-home-basic-interfaces/03-profil-completion.md)
- [Profile summary](https://docs.datanumia.com/docs/DatanumiaHome/08-home-interfaces/02-home-basic-interfaces/04-profil-summary.md)
- [Presentation](https://docs.datanumia.com/docs/DatanumiaRecometrics/01-general-presentation/01-presentation.md)
- [Use cases](https://docs.datanumia.com/docs/DatanumiaRecometrics/01-general-presentation/02-use-cases.md)
- [Core concept](https://docs.datanumia.com/docs/DatanumiaRecometrics/01-general-presentation/03-core-concept.md)
- [API overview](https://docs.datanumia.com/docs/DatanumiaRecometrics/02-recometrics-api/01-api-overview.md)
- [API usage](https://docs.datanumia.com/docs/DatanumiaRecometrics/02-recometrics-api/02-api-usage.md)
- [Advice list](https://docs.datanumia.com/docs/DatanumiaRecometrics/02-recometrics-api/03-advice-list.md)
- [API Example](https://docs.datanumia.com/docs/DatanumiaRecometrics/02-recometrics-api/04-api-example.md)
- [Desk presentation](https://docs.datanumia.com/docs/DatanumiaRecometrics/03-recometrics-desk/01-desk-presentation.md)
- [Connection](https://docs.datanumia.com/docs/DatanumiaRecometrics/03-recometrics-desk/02-connection.md)
- [Client](https://docs.datanumia.com/docs/DatanumiaRecometrics/03-recometrics-desk/03-client.md)
- [Usage](https://docs.datanumia.com/docs/DatanumiaRecometrics/03-recometrics-desk/04-usage.md)
- [Service pour récupérer les variables configurées pour un tenant](https://docs.datanumia.com/api-reference/configuration/service-pour-récupérer-les-variables-configurées-pour-un-tenant.md)
- [Service pour remplacer entièrement la configuration actuelle d'un tenant.](https://docs.datanumia.com/api-reference/configuration/service-pour-remplacer-entièrement-la-configuration-actuelle-dun-tenant.md)
- [Service pour paramétrer les valeurs des variables utilisées par simulation-sys pour un tenant](https://docs.datanumia.com/api-reference/configuration/service-pour-paramétrer-les-valeurs-des-variables-utilisées-par-simulation-sys-pour-un-tenant.md)
- [Service pour supprimer toutes les valeurs des variables d'un tenant.](https://docs.datanumia.com/api-reference/configuration/service-pour-supprimer-toutes-les-valeurs-des-variables-dun-tenant.md)
- [Service pour paramétrer unitairement et par tenant les variables utilisées par simulation-sys.](https://docs.datanumia.com/api-reference/configuration/service-pour-paramétrer-unitairement-et-par-tenant-les-variables-utilisées-par-simulation-sys.md)
- [Service pour supprimer la valeur par défaut d'une variable pour un tenant.](https://docs.datanumia.com/api-reference/configuration/service-pour-supprimer-la-valeur-par-défaut-dune-variable-pour-un-tenant.md)
- [Service pour récupérer toutes les variables d'un client](https://docs.datanumia.com/api-reference/client-data/service-pour-récupérer-toutes-les-variables-dun-client.md)
- [Service pour mettre à jour les variables et leur valeur d'un client](https://docs.datanumia.com/api-reference/client-data/service-pour-mettre-à-jour-les-variables-et-leur-valeur-dun-client.md)
- [Service pour supprimer toutes les variables d'un client](https://docs.datanumia.com/api-reference/client-data/service-pour-supprimer-toutes-les-variables-dun-client.md)
- [Service pour récupérer une variable spécifique assignée à un client](https://docs.datanumia.com/api-reference/client-data/service-pour-récupérer-une-variable-spécifique-assignée-à-un-client.md)
- [Service pour assigner à un client une variable et sa valeur](https://docs.datanumia.com/api-reference/client-data/service-pour-assigner-à-un-client-une-variable-et-sa-valeur.md)
- [Service pour supprimer une variable d'un client](https://docs.datanumia.com/api-reference/client-data/service-pour-supprimer-une-variable-dun-client.md)
- [Service pour enregistrer le consentement d'un client](https://docs.datanumia.com/api-reference/client/service-pour-enregistrer-le-consentement-dun-client.md)
- [Service pour récupérer les clients d'un commercialisateur](https://docs.datanumia.com/api-reference/client/service-pour-récupérer-les-clients-dun-commercialisateur.md)
- [Service pour créer et mettre à jour un client](https://docs.datanumia.com/api-reference/client/service-pour-créer-et-mettre-à-jour-un-client.md)
- [Service pour créer plusieurs clients à l'aide d'un fichier CSV](https://docs.datanumia.com/api-reference/client/service-pour-créer-plusieurs-clients-à-laide-dun-fichier-csv.md)
- [Service pour récupérer un client particulier](https://docs.datanumia.com/api-reference/client/service-pour-récupérer-un-client-particulier.md)
- [Service pour supprimer un client particulier](https://docs.datanumia.com/api-reference/client/service-pour-supprimer-un-client-particulier.md)
- [Service pour modifier les infos d'un client](https://docs.datanumia.com/api-reference/client/service-pour-modifier-les-infos-dun-client.md)
- [Service pour télécharger les données d'un client sous forme de csv](https://docs.datanumia.com/api-reference/client/service-pour-télécharger-les-données-dun-client-sous-forme-de-csv.md)
- [Service pour enregistrer le consentement d'un client](https://docs.datanumia.com/api-reference/client/service-pour-enregistrer-le-consentement-dun-client-1.md)
- [service pour associer un conseil à un tenant](https://docs.datanumia.com/api-reference/tenant/service-pour-associer-un-conseil-à-un-tenant.md)
- [service pour dessocier un conseil à un tenant](https://docs.datanumia.com/api-reference/tenant/service-pour-dessocier-un-conseil-à-un-tenant.md)
- [Service pour récupérer un tenant à partir de son code](https://docs.datanumia.com/api-reference/tenant/service-pour-récupérer-un-tenant-à-partir-de-son-code.md)
- [Service pour supprimer un tenant](https://docs.datanumia.com/api-reference/tenant/service-pour-supprimer-un-tenant.md)
- [service pour recuperer les conseils d'un tenant](https://docs.datanumia.com/api-reference/tenant/service-pour-recuperer-les-conseils-dun-tenant.md)
- [Service pour récupérer tous les commentaires sur un client ](https://docs.datanumia.com/api-reference/client-comment/service-pour-récupérer-tous-les-commentaires-sur-un-client.md)
- [Service pour créer un commentaire par un téléconseiller sur un client ](https://docs.datanumia.com/api-reference/client-comment/service-pour-créer-un-commentaire-par-un-téléconseiller-sur-un-client.md)
- [Service pour supprimer le commentaire d'un téléconseiller sur un client](https://docs.datanumia.com/api-reference/client-comment/service-pour-supprimer-le-commentaire-dun-téléconseiller-sur-un-client.md)
- [Service pour mettre à jour le commentaire d'un téléconseiller sur un client](https://docs.datanumia.com/api-reference/client-comment/service-pour-mettre-à-jour-le-commentaire-dun-téléconseiller-sur-un-client.md)
- [Service de recommandation en json (job)](https://docs.datanumia.com/api-reference/recommandation/service-de-recommandation-en-json-job.md)
- [Service de recommandation pour tenant](https://docs.datanumia.com/api-reference/recommandation/service-de-recommandation-pour-tenant.md)
- [Service de recommandation pour tenant](https://docs.datanumia.com/api-reference/recommandation/service-de-recommandation-pour-tenant-1.md)
- [Service de recommandation en json (job)](https://docs.datanumia.com/api-reference/recommandation/service-de-recommandation-en-json-job-1.md)
- [Service de récupération du graphe de dépendances](https://docs.datanumia.com/api-reference/dépendances/service-de-récupération-du-graphe-de-dépendances.md)
- [Service de récupération des dépendances d'un conseil](https://docs.datanumia.com/api-reference/dépendances/service-de-récupération-des-dépendances-dun-conseil.md)
- [API Overview](https://docs.datanumia.com/docs/DeveloperTools/APIReference/01-api-overview.md)
- [Authentication and authorization](https://docs.datanumia.com/docs/DeveloperTools/APIReference/02-authentication-and-authorization.md)
- [Product configuration](https://docs.datanumia.com/docs/DeveloperTools/APIReference/03-product-configuration.md)
- [Consumptions [deprecated]](https://docs.datanumia.com/api-reference/electric-energy-consumptions/consumptions-[deprecated].md): The service returns the electrical consumption of a given site between two specified dates at the requested step.
- [Consumptions](https://docs.datanumia.com/api-reference/electric-energy-consumptions/consumptions.md): The service returns the electrical consumption of a given site between two specified dates at the requested step.
- [Consumptions with load curve](https://docs.datanumia.com/api-reference/electric-energy-consumptions/consumptions-with-load-curve.md): The service returns the electrical consumption of a given site between two specified dates at the requested step, only by using load curve data.
- [Daily maximum power](https://docs.datanumia.com/api-reference/electric-energy-consumptions/daily-maximum-power.md): The service returns the daily maximal power of a given site between two specified dates.
- [Consumptions](https://docs.datanumia.com/api-reference/gas-energy-consumptions/consumptions.md): The service returns the gas consumption of a given site between two specified dates at the requested step.
- [Monthly and yearly consumptions [deprecated]](https://docs.datanumia.com/api-reference/gas-energy-consumptions/monthly-and-yearly-consumptions-[deprecated].md): The service returns the monthly and yearly gas consumptions of a given site between two specified dates.
- [Daily consumptions [deprecated]](https://docs.datanumia.com/api-reference/gas-energy-consumptions/daily-consumptions-[deprecated].md): The service returns the daily gas consumptions of a given site between two specified dates.
- [Consumptions simulation](https://docs.datanumia.com/api-reference/energy-consumption-simulation/consumptions-simulation.md): The service returns the simulated electrical consumption of a given site  between two specified dates with a given supply contract different from the current site supply contract.
- [Collected daily data statistics](https://docs.datanumia.com/api-reference/collected-daily-data-statistics/collected-daily-data-statistics.md): This service returns the number of distinct sites for which (D+n days) daily indexes and load curve data have been collected.
- [Consumption data extract](https://docs.datanumia.com/api-reference/download-a-sites-consumption-data/consumption-data-extract.md): The service downloads a site’s data used for electricity consumption calculation.
- [Get sites budgetheating](https://docs.datanumia.com/api-reference/get-sites-budgetheating.md): Returns budget vector.
- [Post sites budgetheating](https://docs.datanumia.com/api-reference/post-sites-budgetheating.md): Returns budget vector.
- [Get sites heating schedule](https://docs.datanumia.com/api-reference/get-sites-heating-schedule.md): Returns heating schedule (planning technique).
- [Get sites budgetmatrix](https://docs.datanumia.com/api-reference/get-sites-budgetmatrix.md): Returns budget matrix
- [Get contracts for a SiteId](https://docs.datanumia.com/api-reference/contracts/get-contracts-for-a-siteid.md): Returns the contracts applicable between two dates for a given type of fluid.
- [Create or update a contract](https://docs.datanumia.com/api-reference/contracts/create-or-update-a-contract.md): This API manages the lifecycle of a contract for a given siteID.
- [Get the execution status of all contracts jobs](https://docs.datanumia.com/api-reference/bulk-mode-contracts/get-the-execution-status-of-all-contracts-jobs.md): Returns a list of **jobs** between two dates, with their **state** and an overview of the OK/KO operations Results are paginated.
- [Submit a job](https://docs.datanumia.com/api-reference/bulk-mode-contracts/submit-a-job.md): Allows you to **submit an archive** containing sites' contracts (*see details in "Body" section*).
- [get a job execution status](https://docs.datanumia.com/api-reference/bulk-mode-contracts/get-a-job-execution-status.md): Returns a **job** execution current **state**. Depending on the **state**, a **report** specifying the operations processing details is accessible.
- [return site indexes](https://docs.datanumia.com/api-reference/elec-indexes/return-site-indexes.md): return sites indexes  Provided options:    - WithActiveContract to filter indexes not allocated to contract at endDate (can be activated on demand).    - Invalidation rule which sort indexes by ts and priority. If multiple indexes at the same ts, keep the index with the highest priority. The invalid…
- [Get the execution status of all indexes jobs](https://docs.datanumia.com/api-reference/get-the-execution-status-of-all-indexes-jobs.md): Returns a list of **jobs** between two dates, with their **state** and an overview of the OK/KO operations Results are paginated.
- [Submit an archive](https://docs.datanumia.com/api-reference/submit-an-archive.md): Allows you to submit an archive - encrypted or not - containing consumption data for processing.
- [Get a job execution report](https://docs.datanumia.com/api-reference/get-a-job-execution-report.md): Returns a **job** execution current **state**. Depending on the **state**, a **report** specifying the **operations** processing details is accessible.
- [get a list of persons](https://docs.datanumia.com/api-reference/persons/get-a-list-of-persons.md): Returns a list of persons corresponding to the search criterias.
- [get a person content](https://docs.datanumia.com/api-reference/persons/get-a-person-content.md): This API operation retrieve an existing person.
- [get a list of sites](https://docs.datanumia.com/api-reference/sites/get-a-list-of-sites.md): Returns a list of sites corresponding to the search criterias including their offers statuses.
- [get a site content](https://docs.datanumia.com/api-reference/sites/get-a-site-content.md): This API operation retrieve an existing site.
- [Get sites service offer repartition](https://docs.datanumia.com/api-reference/service-offers/get-sites-service-offer-repartition.md): Returns the repartition of sites by service offer status
- [get the list of jobs](https://docs.datanumia.com/api-reference/bulk-mode-smt/get-the-list-of-jobs.md): Returns the list of jobs that can be requested Results are paginated.
- [Submit a job](https://docs.datanumia.com/api-reference/bulk-mode-smt/submit-a-job.md): This API manages the lifecycle of multiple persons, sites and service offers in a single batch.
- [get a job execution report](https://docs.datanumia.com/api-reference/bulk-mode-smt/get-a-job-execution-report.md): This API retruns a **job** execution current **state**. Depending on the **state**, a **report** specifying the **request** processing details is accessible.
- [Synchronize a person](https://docs.datanumia.com/api-reference/unitary-mode/synchronize-a-person.md): With this endpoint you are able to manage the **person** and its **site** lifecycle:
 
 Handle all the **subscribtion** use cases:
 - Subscribe a new **person** and its **sites** to a **service offer**
 - Subscribe a new **site** of an existing **person** to a **service offer**
 - Subscribe a new **…
- [Get the list of electricity energy prices jobs](https://docs.datanumia.com/api-reference/electricity-energy-prices-bulk/get-the-list-of-electricity-energy-prices-jobs.md): Returns the list of electricity energy prices jobs that can be requested.
- [Submit an electricity energy prices job](https://docs.datanumia.com/api-reference/electricity-energy-prices-bulk/submit-an-electricity-energy-prices-job.md): This API manages the lifecycle of electricity-prices using the bulk mode operation
- [Get the detailed execution status of an electricity energy prices job](https://docs.datanumia.com/api-reference/electricity-energy-prices-bulk/get-the-detailed-execution-status-of-an-electricity-energy-prices-job.md): This url is used to download the JSON file containing the detailed execution status for the job.
- [Retrieve control scenario executions history for a site](https://docs.datanumia.com/api-reference/control-scenarios-executions/retrieve-control-scenario-executions-history-for-a-site.md): This API is used to get control scenarios executions history for a site.
- [Retrieve the breakdown of tariff headings by group for a site](https://docs.datanumia.com/api-reference/tariff-heading-controller/retrieve-the-breakdown-of-tariff-headings-by-group-for-a-site.md)
- [Get sites forecast consumptions](https://docs.datanumia.com/api-reference/forecast-consumptions/get-sites-forecast-consumptions.md): This API estimates energy (gas or electricity) consumption according to the chosen calculation strategy over a given input period. It returns: - estimated consumption - consumption cost - units used for energy and cost
- [Comparison of the annual gaz consumption of similar households](https://docs.datanumia.com/api-reference/households-consumption-comparaison/comparison-of-the-annual-gaz-consumption-of-similar-households.md): This service returns the comparison of the annual consumption in kWh of a given site compared to its average similar households and the lowest consumers.
- [Comparison of the monthly gaz consumption of similar households](https://docs.datanumia.com/api-reference/households-consumption-comparaison/comparison-of-the-monthly-gaz-consumption-of-similar-households.md): This service returns the comparison of the monthly consumption in kWh of a given site in relation to its average similar households and the lowest consumers.
- [Comparison of the annual electricity consumption of similar households](https://docs.datanumia.com/api-reference/households-consumption-comparaison/comparison-of-the-annual-electricity-consumption-of-similar-households.md): This service returns the comparison of the annual consumption in kWh of a given site compared to its average similar households and the lowest consumers.
- [Comparison of the monthly electricity consumption of similar households](https://docs.datanumia.com/api-reference/households-consumption-comparaison/comparison-of-the-monthly-electricity-consumption-of-similar-households.md): This service returns the comparison of the monthly consumption in kWh of a given site in relation to its average similar households and the lowest consumers.
- [Gets targets for a site](https://docs.datanumia.com/api-reference/targets/gets-targets-for-a-site.md): returns the targets for a siteId
- [Creates a target for a site](https://docs.datanumia.com/api-reference/targets/creates-a-target-for-a-site.md): A target is applicable for 12 months and spans from the start of the year to its end. A target can either be a cost in euros (EURO) or a consumption in kWh (KWH). Only ELEC is supported as a fluid type.
- [Returns a target](https://docs.datanumia.com/api-reference/targets/returns-a-target.md): returns a specific target
- [Updates a target for a given site](https://docs.datanumia.com/api-reference/targets/updates-a-target-for-a-given-site.md): Updates an existing target. Only targetValue, notificationChannels and notificationType can be updated. Any attempt to do otherwise will generate a functional error.
- [Returns the analysis for a target](https://docs.datanumia.com/api-reference/targets/returns-the-analysis-for-a-target.md): returns the analysis for a target
- [Gets the target reference](https://docs.datanumia.com/api-reference/targets/gets-the-target-reference.md): returns the target reference (default target) from past consumptions or similar homes
- [Get sites monthly comparisons](https://docs.datanumia.com/api-reference/get-sites-monthly-comparisons.md): get the monthly gas energies comparison between the months of the current year (given as paramter 'year') and the months of the previous year
- [Get sites yearly gas energies comparisons](https://docs.datanumia.com/api-reference/get-sites-yearly-gas-energies-comparisons.md): Get the yearly gas energies comparison between a year and the previous year for a list of years
- [Comparison of consumptions between two periods.](https://docs.datanumia.com/api-reference/comparison-of-consumptions-between-two-periods.md): This API is used to get consumption comparisons between two periods : selected period and reference period. Selected period is the period that needs to be compared. Reference period is the period to which the selected period is compared to.
- [Retrieve the comparison of annual electric energies in kWh between one
year and the previous year, for a list of years, by tariff item (graph
of comparison of annual energies.
](https://docs.datanumia.com/api-reference/yearly-elec-comparison/retrieve-the-comparison-of-annual-electric-energies-in-kwh-between-oneyear-and-the-previous-year-for-a-list-of-years-by-tariff-item-graphof-comparison-of-annual-energies.md): Returning service for each year compared: the months between which the comparison was made, the electric energies by rate line of the site in Wh over the years requested, the percentage of evolution between the two years.
- [Disaggregation](https://docs.datanumia.com/api-reference/annual-energy-disaggregation/disaggregation.md): The service returns the annual energy disaggregation of a given site.
- [Disaggregation](https://docs.datanumia.com/api-reference/monthly-energy-disaggregation/disaggregation.md): The service returns the monthly energy disaggregation of a given site between two specified dates.
- [Service returning the daily average temperatures for a weather station. Also returns the associated pictogram](https://docs.datanumia.com/api-reference/weather-stations/service-returning-the-daily-average-temperatures-for-a-weather-station-also-returns-the-associated-pictogram.md): Service returning the daily average temperatures for a weather station. Also returns the associated pictogram
- [Service returning the monthly average temperatures for a weather station. Data sorted by date.](https://docs.datanumia.com/api-reference/weather-stations/service-returning-the-monthly-average-temperatures-for-a-weather-station-data-sorted-by-date.md): Service returning the monthly average temperatures for a weather station. Data sorted by date.
- [Service returning the weather station code associated with the zipcode.](https://docs.datanumia.com/api-reference/weather-stations/service-returning-the-weather-station-code-associated-with-the-zipcode.md): Service returning the weather station code associated with the zipcode.
- [Service returning the daily average temperatures for a weather station. Also returns the associated pictogram](https://docs.datanumia.com/api-reference/daily-weathers/service-returning-the-daily-average-temperatures-for-a-weather-station-also-returns-the-associated-pictogram.md): Service returning the daily average temperatures for a weather station. Also returns the associated pictogram
- [Service returning the monthly average temperatures for a weather station. Data sorted by date.](https://docs.datanumia.com/api-reference/monthly-temperatures/service-returning-the-monthly-average-temperatures-for-a-weather-station-data-sorted-by-date.md): Service returning the monthly average temperatures for a weather station. Data sorted by date.
- [Recuperer le pourcentage du chauffage electrique mensuel](https://docs.datanumia.com/api-reference/monthly-elec-heating-percents/recuperer-le-pourcentage-du-chauffage-electrique-mensuel.md)
- [Service returning all the weather informations associated to a site for a period. The weather data is retrieved from the weather station associated to the site](https://docs.datanumia.com/api-reference/weathers/service-returning-all-the-weather-informations-associated-to-a-site-for-a-period-the-weather-data-is-retrieved-from-the-weather-station-associated-to-the-site.md): Service returning all the weather informations associated to a site for a period. The weather data is retrieved from the weather station associated to the site. No disttinction is made between forecasted temperature and mesured ones
- [Service returning the evolution Colder / Warmer / Neutral for a site for a period.](https://docs.datanumia.com/api-reference/weathers-comparison/service-returning-the-evolution-colder-warmer-neutral-for-a-site-for-a-period.md): Service returning the evolution Colder / Warmer / Neutral for a site for a period.
- [Get challenges (depending on the provided site and filters)](https://docs.datanumia.com/api-reference/challenge/get-challenges-depending-on-the-provided-site-and-filters.md): This API returns : - a filtered, ordered and sorted list of challenges - the date of engagement, i.e. the date when the site engaged (if the site didn't engage, the date is not returned) - the number of sites participating in the challenge (the number of engaged sites) - the actual consumption since…
- [Get sites challenges actions](https://docs.datanumia.com/api-reference/challenges-actions/get-sites-challenges-actions.md): This API returns : - the targeted actions for the site and the challenge - the usage type per action - the status per action (ALREADY_DONE or ENGAGED) - the number of engaged sites per action - the estimated saving percentage on the usage per action
- [Get sites actions](https://docs.datanumia.com/api-reference/actions/get-sites-actions.md): This API returns : - the targeted actions for the site - the usage type per action - the estimated saving percentage on the usage per action
- [Create or update the user engagement status on any challenge's action](https://docs.datanumia.com/api-reference/challenges-engagement/create-or-update-the-user-engagement-status-on-any-challenges-action.md): An engagement refers to the active participation of a user in a given challenge.
- [Returns the history of the challenges engaged with the actions engaged for a site-id](https://docs.datanumia.com/api-reference/rgpd/returns-the-history-of-the-challenges-engaged-with-the-actions-engaged-for-a-site-id.md)
- [Get removed consumptions (depending on the provided site and filters)](https://docs.datanumia.com/api-reference/removedconsumptions/get-removed-consumptions-depending-on-the-provided-site-and-filters.md): This API returns : - a filtered list of removed consumptions - a list of removals aggregations by type of challenge
- [How to insert webcomponents in an app?](https://docs.datanumia.com/docs/DeveloperTools/HomeInteface/01-how-to-insert-webcomponents-in-an-app.md)
- [How to parameter webcomponents?](https://docs.datanumia.com/docs/DeveloperTools/HomeInteface/02-how-to-parameter-webcomponents.md)
- [Security](https://docs.datanumia.com/docs/DeveloperTools/HomeInteface/04-security.md)
- [Consumption calculation](https://docs.datanumia.com/docs/DeveloperTools/HomeInteface/05-home-basic/01-consumption-calculation.md)
- [Consumption disaggregation](https://docs.datanumia.com/docs/DeveloperTools/HomeInteface/05-home-basic/02-consumption-disaggregation.md)
- [Profile completion](https://docs.datanumia.com/docs/DeveloperTools/HomeInteface/05-home-basic/03-profil-completion.md)
- [Profile summary](https://docs.datanumia.com/docs/DeveloperTools/HomeInteface/05-home-basic/04-profil-summary.md)

## OpenAPI Specs

- [brain-admin](/api-reference/brain-admin.yaml)
- [comparison](/api-reference/comparison.yaml)
- [contracts](/api-reference/contracts.yaml)
- [control-scenario-api-v2](/api-reference/control-scenario-api-v2.yaml)
- [elec-index-api](/api-reference/elec-index-api.yaml)
- [elec-similar-home](/api-reference/elec-similar-home.yaml)
- [elec-tariff-api](/api-reference/elec-tariff-api.yaml)
- [energy-consumption](/api-reference/energy-consumption.yaml)
- [energy-disaggregation](/api-reference/energy-disaggregation.yaml)
- [forecast](/api-reference/forecast.yaml)
- [gas-similar-home](/api-reference/gas-similar-home.yaml)
- [green-actions](/api-reference/green-actions.yaml)
- [indexes-collect-api](/api-reference/indexes-collect-api.yaml)
- [part-budget-api](/api-reference/part-budget-api.yaml)
- [persons-sites-service-offers](/api-reference/persons-sites-service-offers.yaml)
- [simulation-sys](/api-reference/simulation-sys.yaml)
- [targets](/api-reference/targets.yaml)
- [tariff-heading-api](/api-reference/tariff-heading-api.yaml)
- [weather-api](/api-reference/weather-api.yaml)